Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unit tests for android_sdk and AndroidProject #464

Merged
merged 3 commits into from
Sep 2, 2018
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions bin/templates/cordova/lib/android_sdk.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
under the License.
*/

var Q = require('q');
var superspawn = require('cordova-common').superspawn;

var suffix_number_regex = /(\d+)$/;
Expand Down Expand Up @@ -95,7 +94,7 @@ module.exports.list_targets = function () {
} else throw err;
}).then(function (targets) {
if (targets.length === 0) {
return Q.reject(new Error('No android targets (SDKs) installed!'));
return Promise.reject(new Error('No android targets (SDKs) installed!'));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to simply throw the Errors instead of wrapping them in a rejection and returning them. Might be personal taste though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no strong feelings either way. But, when replacing Q, I wanted to keep the changes as simple as possible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough

}
return targets;
});
Expand Down
134 changes: 134 additions & 0 deletions spec/unit/AndroidProject.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
/**
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('path');
const rewire = require('rewire');

describe('AndroidProject', () => {
const PROJECT_DIR = 'platforms/android';
let AndroidProject;
let AndroidStudioSpy;

beforeEach(() => {
AndroidProject = rewire('../../bin/templates/cordova/lib/AndroidProject');

AndroidStudioSpy = jasmine.createSpyObj('AndroidStudio', ['isAndroidStudioProject']);
AndroidProject.__set__('AndroidStudio', AndroidStudioSpy);
});

describe('constructor', () => {
it('should set the project directory', () => {
const project = new AndroidProject(PROJECT_DIR);
expect(project.projectDir).toBe(PROJECT_DIR);
});

it('should set www folder correctly if not Android Studio project', () => {
AndroidStudioSpy.isAndroidStudioProject.and.returnValue(false);

const project = new AndroidProject(PROJECT_DIR);
expect(project.www).toBe(path.join(PROJECT_DIR, 'assets/www'));
});

it('should set www folder correctly if it is an Android Studio project', () => {
AndroidStudioSpy.isAndroidStudioProject.and.returnValue(true);

const project = new AndroidProject(PROJECT_DIR);
expect(project.www).toBe(path.join(PROJECT_DIR, 'app/src/main/assets/www'));
});
});

describe('getProjectFile', () => {
it('should create and return a new project if one does not exist', () => {
const newProject = AndroidProject.getProjectFile(PROJECT_DIR);

expect(newProject).toEqual(jasmine.any(AndroidProject));
});

it('should cache created projects', () => {
const newProject = AndroidProject.getProjectFile(PROJECT_DIR);
const secondProject = AndroidProject.getProjectFile(PROJECT_DIR);

expect(newProject).toEqual(jasmine.any(AndroidProject));
expect(secondProject).toBe(newProject);
});
});

describe('purgeCache', () => {
beforeEach(() => {
AndroidProject.__set__('projectFileCache', {
project1: 'test',
project2: 'anothertest',
project3: 'finaltest'
});
});

it('should only remove the specified project from the cache', () => {
const projectToRemove = 'project2';
AndroidProject.purgeCache(projectToRemove);

const cache = AndroidProject.__get__('projectFileCache');
expect(Object.keys(cache).length).toBe(2);
expect(cache[projectToRemove]).toBe(undefined);
});

it('should remove all projects from cache', () => {
AndroidProject.purgeCache();

const cache = AndroidProject.__get__('projectFileCache');
expect(Object.keys(cache).length).toBe(0);
});
});

describe('getPackageName', () => {
let AndroidManifestSpy;
let AndroidManifestFns;
let androidProject;

beforeEach(() => {
AndroidManifestFns = jasmine.createSpyObj('AndroidManifestFns', ['getPackageId']);
AndroidManifestSpy = jasmine.createSpy('AndroidManifest').and.returnValue(AndroidManifestFns);
AndroidProject.__set__('AndroidManifest', AndroidManifestSpy);

androidProject = new AndroidProject(PROJECT_DIR);
});

it('should get the package name from the project root manifest', () => {
AndroidStudioSpy.isAndroidStudioProject.and.returnValue(false);

androidProject.getPackageName();

expect(AndroidManifestSpy).toHaveBeenCalledWith(path.join(PROJECT_DIR, 'AndroidManifest.xml'));
});

it('should get the package name from the Android Studio manifest', () => {
AndroidStudioSpy.isAndroidStudioProject.and.returnValue(true);

androidProject.getPackageName();

expect(AndroidManifestSpy).toHaveBeenCalledWith(path.join(PROJECT_DIR, 'app/src/main/AndroidManifest.xml'));
});

it('should return the package name', () => {
const packageName = 'io.cordova.unittest';
AndroidManifestFns.getPackageId.and.returnValue(packageName);

expect(androidProject.getPackageName()).toBe(packageName);
});
});
});