mirror of
https://github.com/apache/cordova-android.git
synced 2026-04-04 00:02:03 +08:00
Remove unused builders and add unit tests
This commit is contained in:
Gearoid M
@@ -1,28 +0,0 @@
|
||||
|
||||
var Gradle_builder = require('../../../bin/templates/cordova/lib/builders/GradleBuilder.js');
|
||||
var fs = require('fs');
|
||||
var Q = require('q');
|
||||
var superspawn = require('cordova-common').superspawn;
|
||||
var builder;
|
||||
|
||||
describe('Gradle Builder', function () {
|
||||
beforeEach(function () {
|
||||
spyOn(fs, 'existsSync').and.returnValue(true);
|
||||
builder = new Gradle_builder('/root');
|
||||
var deferred = Q.defer();
|
||||
spyOn(superspawn, 'spawn').and.returnValue(deferred.promise);
|
||||
});
|
||||
|
||||
describe('runGradleWrapper method', function () {
|
||||
it('should run the provided gradle command if a gradle wrapper does not already exist', function () {
|
||||
fs.existsSync.and.returnValue(false);
|
||||
builder.runGradleWrapper('/my/sweet/gradle');
|
||||
expect(superspawn.spawn).toHaveBeenCalledWith('/my/sweet/gradle', jasmine.any(Array), jasmine.any(Object));
|
||||
});
|
||||
it('should do nothing if a gradle wrapper exists in the project directory', function () {
|
||||
fs.existsSync.and.returnValue(true);
|
||||
builder.runGradleWrapper('/my/sweet/gradle');
|
||||
expect(superspawn.spawn).not.toHaveBeenCalledWith('/my/sweet/gradle', jasmine.any(Array), jasmine.any(Object));
|
||||
});
|
||||
});
|
||||
});
|
||||
289
spec/unit/builders/ProjectBuilder.spec.js
Normal file
289
spec/unit/builders/ProjectBuilder.spec.js
Normal file
@@ -0,0 +1,289 @@
|
||||
/*
|
||||
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 fs = require('fs');
|
||||
const path = require('path');
|
||||
const Q = require('q');
|
||||
const rewire = require('rewire');
|
||||
|
||||
const CordovaError = require('cordova-common').CordovaError;
|
||||
|
||||
describe('ProjectBuilder', () => {
|
||||
const rootDir = '/root';
|
||||
|
||||
let builder;
|
||||
let ProjectBuilder;
|
||||
let spawnSpy;
|
||||
|
||||
beforeEach(() => {
|
||||
spawnSpy = jasmine.createSpy('spawn').and.returnValue(Q.defer().promise);
|
||||
ProjectBuilder = rewire('../../../bin/templates/cordova/lib/builders/ProjectBuilder');
|
||||
ProjectBuilder.__set__('spawn', spawnSpy);
|
||||
|
||||
builder = new ProjectBuilder(rootDir);
|
||||
});
|
||||
|
||||
describe('constructor', () => {
|
||||
it('should set the project directory to the passed argument', () => {
|
||||
expect(builder.root).toBe(rootDir);
|
||||
});
|
||||
|
||||
it('should set the project directory to three folders up', () => {
|
||||
ProjectBuilder.__set__('__dirname', 'projecttest/platforms/android/app');
|
||||
builder = new ProjectBuilder();
|
||||
expect(builder.root).toMatch(/projecttest$/);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getArgs', () => {
|
||||
beforeEach(() => {
|
||||
spyOn(fs, 'existsSync').and.returnValue(true);
|
||||
});
|
||||
|
||||
it('should set release argument', () => {
|
||||
const args = builder.getArgs('release', {});
|
||||
expect(args[0]).toBe('cdvBuildRelease');
|
||||
});
|
||||
|
||||
it('should set debug argument', () => {
|
||||
const args = builder.getArgs('debug', {});
|
||||
expect(args[0]).toBe('cdvBuildDebug');
|
||||
});
|
||||
|
||||
it('should add architecture if it is passed', () => {
|
||||
const arch = 'unittest';
|
||||
const args = builder.getArgs('debug', { arch });
|
||||
|
||||
expect(args).toContain(`-PcdvBuildArch=${arch}`);
|
||||
});
|
||||
});
|
||||
|
||||
describe('runGradleWrapper', () => {
|
||||
it('should run the provided gradle command if a gradle wrapper does not already exist', () => {
|
||||
spyOn(fs, 'existsSync').and.returnValue(false);
|
||||
builder.runGradleWrapper('/my/sweet/gradle');
|
||||
expect(spawnSpy).toHaveBeenCalledWith('/my/sweet/gradle', jasmine.any(Array), jasmine.any(Object));
|
||||
});
|
||||
|
||||
it('should do nothing if a gradle wrapper exists in the project directory', () => {
|
||||
spyOn(fs, 'existsSync').and.returnValue(true);
|
||||
builder.runGradleWrapper('/my/sweet/gradle');
|
||||
expect(spawnSpy).not.toHaveBeenCalledWith('/my/sweet/gradle', jasmine.any(Array), jasmine.any(Object));
|
||||
});
|
||||
});
|
||||
|
||||
describe('extractRealProjectNameFromManifest', () => {
|
||||
it('should get the project name from the Android Manifest', () => {
|
||||
const projectName = 'unittestproject';
|
||||
const projectId = `io.cordova.${projectName}`;
|
||||
const manifest = `<?xml version="1.0" encoding="utf-8"?>
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
||||
package="${projectId}"></manifest>`;
|
||||
|
||||
spyOn(fs, 'readFileSync').and.returnValue(manifest);
|
||||
|
||||
expect(builder.extractRealProjectNameFromManifest()).toBe(projectName);
|
||||
});
|
||||
|
||||
it('should throw an error if there is no package in the Android manifest', () => {
|
||||
const manifest = `<?xml version="1.0" encoding="utf-8"?>
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"></manifest>`;
|
||||
|
||||
spyOn(fs, 'readFileSync').and.returnValue(manifest);
|
||||
|
||||
expect(() => builder.extractRealProjectNameFromManifest()).toThrow(jasmine.any(CordovaError));
|
||||
});
|
||||
});
|
||||
|
||||
describe('build', () => {
|
||||
beforeEach(() => {
|
||||
spyOn(builder, 'getArgs');
|
||||
});
|
||||
|
||||
it('should set build type to debug', () => {
|
||||
const opts = { buildType: 'debug' };
|
||||
builder.build(opts);
|
||||
expect(builder.getArgs).toHaveBeenCalledWith('debug', opts);
|
||||
});
|
||||
|
||||
it('should set build type to release', () => {
|
||||
const opts = { buildType: 'release' };
|
||||
builder.build(opts);
|
||||
expect(builder.getArgs).toHaveBeenCalledWith('release', opts);
|
||||
});
|
||||
|
||||
it('should default build type to release', () => {
|
||||
const opts = {};
|
||||
builder.build(opts);
|
||||
expect(builder.getArgs).toHaveBeenCalledWith('release', opts);
|
||||
});
|
||||
|
||||
it('should spawn gradle with correct args', () => {
|
||||
const testArgs = ['test', 'args', '-c'];
|
||||
builder.getArgs.and.returnValue(testArgs);
|
||||
|
||||
builder.build({});
|
||||
|
||||
expect(spawnSpy).toHaveBeenCalledWith(path.join(rootDir, 'gradlew'), testArgs, jasmine.anything());
|
||||
});
|
||||
|
||||
it('should reject if the spawn fails', () => {
|
||||
const errorMessage = 'ERROR: Failed to spawn';
|
||||
spawnSpy.and.returnValue(Q.reject(errorMessage));
|
||||
|
||||
return builder.build({}).then(
|
||||
() => fail('Unexpectedly resolved'),
|
||||
err => {
|
||||
expect(err).toBe(errorMessage);
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('should check the Android target if failed to find target', () => {
|
||||
const checkReqsSpy = jasmine.createSpyObj('check_reqs', ['check_android_target']);
|
||||
const errorMessage = 'ERROR: failed to find target with hash string';
|
||||
|
||||
ProjectBuilder.__set__('check_reqs', checkReqsSpy);
|
||||
checkReqsSpy.check_android_target.and.returnValue(Q.resolve());
|
||||
spawnSpy.and.returnValue(Q.reject(errorMessage));
|
||||
|
||||
return builder.build({}).then(
|
||||
() => fail('Unexpectedly resolved'),
|
||||
err => {
|
||||
expect(checkReqsSpy.check_android_target).toHaveBeenCalledWith(errorMessage);
|
||||
expect(err).toBe(errorMessage);
|
||||
}
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('clean', () => {
|
||||
let shellSpy;
|
||||
|
||||
beforeEach(() => {
|
||||
shellSpy = jasmine.createSpyObj('shell', ['rm']);
|
||||
ProjectBuilder.__set__('shell', shellSpy);
|
||||
spyOn(builder, 'getArgs');
|
||||
spawnSpy.and.returnValue(Promise.resolve());
|
||||
});
|
||||
|
||||
it('should get arguments for cleaning', () => {
|
||||
const opts = {};
|
||||
builder.clean(opts);
|
||||
|
||||
expect(builder.getArgs).toHaveBeenCalledWith('clean', opts);
|
||||
});
|
||||
|
||||
it('should spawn gradle', () => {
|
||||
const opts = {};
|
||||
const gradleArgs = ['test', 'args', '-f'];
|
||||
builder.getArgs.and.returnValue(gradleArgs);
|
||||
|
||||
return builder.clean(opts).then(() => {
|
||||
expect(spawnSpy).toHaveBeenCalledWith(path.join(rootDir, 'gradlew'), gradleArgs, jasmine.anything());
|
||||
});
|
||||
});
|
||||
|
||||
it('should remove "out" folder', () => {
|
||||
return builder.clean({}).then(() => {
|
||||
expect(shellSpy.rm).toHaveBeenCalledWith('-rf', path.join(rootDir, 'out'));
|
||||
});
|
||||
});
|
||||
|
||||
it('should remove signing files if they are autogenerated', () => {
|
||||
const debugSigningFile = path.join(rootDir, 'debug-signing.properties');
|
||||
const releaseSigningFile = path.join(rootDir, 'release-signing.properties');
|
||||
|
||||
const isAutoGeneratedSpy = jasmine.createSpy('isAutoGenerated');
|
||||
ProjectBuilder.__set__('isAutoGenerated', isAutoGeneratedSpy);
|
||||
isAutoGeneratedSpy.and.returnValue(true);
|
||||
|
||||
return builder.clean({}).then(() => {
|
||||
expect(shellSpy.rm).toHaveBeenCalledWith(jasmine.any(String), debugSigningFile);
|
||||
expect(shellSpy.rm).toHaveBeenCalledWith(jasmine.any(String), releaseSigningFile);
|
||||
});
|
||||
});
|
||||
|
||||
it('should not remove signing files if they are not autogenerated', () => {
|
||||
const debugSigningFile = path.join(rootDir, 'debug-signing.properties');
|
||||
const releaseSigningFile = path.join(rootDir, 'release-signing.properties');
|
||||
|
||||
const isAutoGeneratedSpy = jasmine.createSpy('isAutoGenerated');
|
||||
ProjectBuilder.__set__('isAutoGenerated', isAutoGeneratedSpy);
|
||||
isAutoGeneratedSpy.and.returnValue(false);
|
||||
|
||||
return builder.clean({}).then(() => {
|
||||
expect(shellSpy.rm).not.toHaveBeenCalledWith(jasmine.any(String), debugSigningFile);
|
||||
expect(shellSpy.rm).not.toHaveBeenCalledWith(jasmine.any(String), releaseSigningFile);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('apkSorter', () => {
|
||||
it('should sort APKs from most recent to oldest, deprioritising unsigned arch-specific builds', () => {
|
||||
const APKs = {
|
||||
'app-debug.apk': new Date('2018-04-20'),
|
||||
'app-release.apk': new Date('2018-05-20'),
|
||||
'app-debug-x86.apk': new Date('2018-06-01'),
|
||||
'app-release-x86.apk': new Date('2018-06-20'),
|
||||
'app-debug-arm.apk': new Date('2018-05-24'),
|
||||
'app-release-arm.apk': new Date('2018-06-24'),
|
||||
'app-release-unsigned.apk': new Date('2018-06-28')
|
||||
};
|
||||
|
||||
const expectedResult = ['app-release.apk', 'app-debug.apk', 'app-release-unsigned.apk',
|
||||
'app-release-arm.apk', 'app-debug-arm.apk', 'app-release-x86.apk', 'app-debug-x86.apk'];
|
||||
|
||||
const fsSpy = jasmine.createSpyObj('fs', ['statSync']);
|
||||
fsSpy.statSync.and.callFake(filename => {
|
||||
return { mtime: APKs[filename].getTime() };
|
||||
});
|
||||
ProjectBuilder.__set__('fs', fsSpy);
|
||||
|
||||
const apkArray = Object.keys(APKs);
|
||||
const sortedApks = apkArray.sort(ProjectBuilder.__get__('apkSorter'));
|
||||
|
||||
expect(sortedApks).toEqual(expectedResult);
|
||||
});
|
||||
});
|
||||
|
||||
describe('isAutoGenerated', () => {
|
||||
let fsSpy;
|
||||
|
||||
beforeEach(() => {
|
||||
fsSpy = jasmine.createSpyObj('fs', ['existsSync', 'readFileSync']);
|
||||
fsSpy.existsSync.and.returnValue(true);
|
||||
ProjectBuilder.__set__('fs', fsSpy);
|
||||
});
|
||||
|
||||
it('should return true if the file contains the autogenerated marker', () => {
|
||||
const fileContents = `# DO NOT MODIFY - YOUR CHANGES WILL BE ERASED!`;
|
||||
fsSpy.readFileSync.and.returnValue(fileContents);
|
||||
|
||||
expect(ProjectBuilder.__get__('isAutoGenerated')()).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false if the file does not contain the autogenerated marker', () => {
|
||||
const fileContents = `# My modified file`;
|
||||
fsSpy.readFileSync.and.returnValue(fileContents);
|
||||
|
||||
expect(ProjectBuilder.__get__('isAutoGenerated')()).toBe(false);
|
||||
});
|
||||
});
|
||||
});
|
||||
54
spec/unit/builders/builders.spec.js
Normal file
54
spec/unit/builders/builders.spec.js
Normal file
@@ -0,0 +1,54 @@
|
||||
/**
|
||||
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 rewire = require('rewire');
|
||||
|
||||
const CordovaError = require('cordova-common').CordovaError;
|
||||
const ProjectBuilder = require('../../../bin/templates/cordova/lib/builders/ProjectBuilder');
|
||||
|
||||
describe('builders', () => {
|
||||
let builders;
|
||||
|
||||
beforeEach(() => {
|
||||
builders = rewire('../../../bin/templates/cordova/lib/builders/builders');
|
||||
});
|
||||
|
||||
describe('getBuilder', () => {
|
||||
it('should return an instance of ProjectBuilder when gradle is requested', () => {
|
||||
const newBuilder = builders.getBuilder('gradle');
|
||||
expect(newBuilder).toEqual(jasmine.any(ProjectBuilder));
|
||||
});
|
||||
|
||||
it('should return an instance of ProjectBuilder when studio is requested', () => {
|
||||
const newBuilder = builders.getBuilder('studio');
|
||||
expect(newBuilder).toEqual(jasmine.any(ProjectBuilder));
|
||||
});
|
||||
|
||||
it('should throw an error if the selected builder does not exist', () => {
|
||||
expect(() => builders.getBuilder('NonExistentBuilder')).toThrow(jasmine.any(CordovaError));
|
||||
});
|
||||
|
||||
it('should throw an error if a builder cannot be instantiated', () => {
|
||||
const requireSpy = jasmine.createSpy('require').and.throwError();
|
||||
builders.__set__('require', requireSpy);
|
||||
|
||||
expect(() => builders.getBuilder('gradle')).toThrow(jasmine.any(CordovaError));
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user