Fix some issues about the provision switch

Author: PanayotCankov

lib/bootstrap.ts

@@ -124,4 +124,7 @@ $injector.require("projectChangesService", "./services/project-changes-service")
 
 $injector.require("emulatorPlatformService", "./services/emulator-platform-service");
 
+$injector.require("pbxprojDomXcode", "./services/pbxproj-dom-xcode");
+
 $injector.require("staticConfig", "./config");
+

lib/declarations.d.ts

@@ -98,7 +98,7 @@ interface IClean {
 }
 
 interface IProvision {
-	provision: any;
+	provision: string;
 }
 
 interface ITeamIdentifier {

lib/definitions/project-changes.d.ts

@@ -15,8 +15,11 @@ interface IProjectChangesInfo {
 	configChanged: boolean;
 	packageChanged: boolean;
 	nativeChanged: boolean;
-	hasChanges: boolean;
-	changesRequireBuild: boolean;
+	signingChanged: boolean;
+
+	readonly hasChanges: boolean;
+	readonly changesRequireBuild: boolean;
+	readonly changesRequirePrepare: boolean;
 }
 
 interface IProjectChangesOptions extends IAppFilesUpdaterOptions, IProvision {}

lib/definitions/project.d.ts

@@ -258,6 +258,12 @@ interface IPlatformProjectService extends NodeJS.EventEmitter {
 	 * @returns {void}
 	 */
 	cleanProject(projectRoot: string, projectData: IProjectData): Promise<void>
+
+	/**
+	 * Check the current state of the project, and validate against the options.
+	 * If there are parts in the project that are inconsistent with the desired options, marks them in the changeset flags.
+	 */
+	checkForChanges(changeset: IProjectChangesInfo, options: IProjectChangesOptions, projectData: IProjectData): void;
 }
 
 interface IAndroidProjectPropertiesManager {

lib/services/android-project-service.ts

@@ -435,6 +435,10 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		await adb.executeShellCommand(["rm", "-rf", deviceRootPath]);
 	}
 
+	public checkForChanges(changesInfo: IProjectChangesInfo, options: IProjectChangesOptions, projectData: IProjectData): void {
+		// Nothing android specific to check yet.
+	}
+
 	private _canUseGradle: boolean;
 	private canUseGradle(projectData: IProjectData, frameworkVersion?: string): boolean {
 		if (!this._canUseGradle) {

lib/services/ios-project-service.ts

@@ -11,7 +11,6 @@ import { PlistSession } from "plist-merge-patch";
 import { EOL } from "os";
 import * as temp from "temp";
 import * as plist from "plist";
-import { Xcode } from "pbxproj-dom/xcode";
 import { IOSProvisionService } from "./ios-provision-service";
 
 export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase implements IPlatformProjectService {
@@ -42,7 +41,8 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		private $pluginVariablesService: IPluginVariablesService,
 		private $xcprojService: IXcprojService,
 		private $iOSProvisionService: IOSProvisionService,
-		private $sysInfo: ISysInfo) {
+		private $sysInfo: ISysInfo,
+		private $pbxprojDomXcode: IPbxprojDomXcode) {
 		super($fs, $projectDataService);
 	}
 
@@ -379,10 +379,9 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		await this.createIpa(projectRoot, projectData, buildConfig);
 	}
 
-	private async setupSigningFromProvision(projectRoot: string, projectData: IProjectData, provision?: any): Promise<void> {
+	private async setupSigningFromProvision(projectRoot: string, projectData: IProjectData, provision?: string): Promise<void> {
 		if (provision) {
-			const pbxprojPath = path.join(projectRoot, projectData.projectName + ".xcodeproj", "project.pbxproj");
-			const xcode = Xcode.open(pbxprojPath);
+			const xcode = this.$pbxprojDomXcode.Xcode.open(this.getPbxProjPath(projectData));
 			const signing = xcode.getSigning(projectData.projectName);
 
 			let shouldUpdateXcode = false;
@@ -399,8 +398,6 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 			}
 
 			if (shouldUpdateXcode) {
-				// This is slow, it read through 260 mobileprovision files on my machine and does quite some checking whether provisioning profiles and devices will match.
-				// That's why we try to avoid id by checking in the Xcode first.
 				const pickStart = Date.now();
 				const mobileprovision = await this.$iOSProvisionService.pick(provision, projectData.projectId);
 				const pickEnd = Date.now();
@@ -428,11 +425,16 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 	}
 
 	private async setupSigningForDevice(projectRoot: string, buildConfig: IiOSBuildConfig, projectData: IProjectData): Promise<void> {
-		const pbxprojPath = path.join(projectRoot, projectData.projectName + ".xcodeproj", "project.pbxproj");
-		const xcode = Xcode.open(pbxprojPath);
+		const xcode = this.$pbxprojDomXcode.Xcode.open(this.getPbxProjPath(projectData));
 		const signing = xcode.getSigning(projectData.projectName);
 
-		if ((this.readXCConfigProvisioningProfile(projectData) || this.readXCConfigProvisioningProfileForIPhoneOs(projectData)) && (!signing || signing.style !== "Manual")) {
+		const hasProvisioningProfileInXCConfig =
+			this.readXCConfigProvisioningProfileSpecifierForIPhoneOs(projectData) ||
+			this.readXCConfigProvisioningProfileSpecifier(projectData) ||
+			this.readXCConfigProvisioningProfileForIPhoneOs(projectData) ||
+			this.readXCConfigProvisioningProfile(projectData);
+
+		if (hasProvisioningProfileInXCConfig && (!signing || signing.style !== "Manual")) {
 			xcode.setManualSigningStyle(projectData.projectName);
 			xcode.save();
 		} else if (!buildConfig.provision && !(signing && signing.style === "Manual" && !buildConfig.teamId)) {
@@ -623,7 +625,7 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 
 		if (provision) {
 			let projectRoot = path.join(projectData.platformsDir, "ios");
-			await this.setupSigningFromProvision(projectRoot, provision);
+			await this.setupSigningFromProvision(projectRoot, projectData, provision);
 		}
 
 		let project = this.createPbxProj(projectData);
@@ -844,6 +846,35 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 		return Promise.resolve();
 	}
 
+	public checkForChanges(changesInfo: IProjectChangesInfo, options: IProjectChangesOptions, projectData: IProjectData): void {
+		const provision = options.provision;
+		if (provision !== undefined) {
+			// Check if the native project's signing is set to the provided provision...
+			const pbxprojPath = this.getPbxProjPath(projectData);
+
+			if (this.$fs.exists(pbxprojPath)) {
+				const xcode = this.$pbxprojDomXcode.Xcode.open(pbxprojPath);
+				const signing = xcode.getSigning(projectData.projectName);
+				if (signing && signing.style === "Manual") {
+					for (let name in signing.configurations) {
+						let config = signing.configurations[name];
+						if (config.uuid !== provision && config.name !== provision) {
+							changesInfo.signingChanged = true;
+							break;
+						}
+					}
+				} else {
+					// Specifying provisioning profile requires "Manual" signing style.
+					// If the current signing style was not "Manual" it was probably "Automatic" or,
+					// it was not uniform for the debug and release build configurations.
+					changesInfo.signingChanged = true;
+				}
+			} else {
+				changesInfo.signingChanged = true;
+			}
+		}
+	}
+
 	private getAllLibsForPluginWithFileExtension(pluginData: IPluginData, fileExtension: string): string[] {
 		let filterCallback = (fileName: string, pluginPlatformsFolderPath: string) => path.extname(fileName) === fileExtension;
 		return this.getAllNativeLibrariesForPlugin(pluginData, IOSProjectService.IOS_PLATFORM_NAME, filterCallback);
@@ -1186,6 +1217,14 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 		return this.readXCConfig("PROVISIONING_PROFILE[sdk=iphoneos*]", projectData);
 	}
 
+	private readXCConfigProvisioningProfileSpecifier(projectData: IProjectData): string {
+		return this.readXCConfig("PROVISIONING_PROFILE_SPECIFIER", projectData);
+	}
+
+	private readXCConfigProvisioningProfileSpecifierForIPhoneOs(projectData: IProjectData): string {
+		return this.readXCConfig("PROVISIONING_PROFILE_SPECIFIER[sdk=iphoneos*]", projectData);
+	}
+
 	private async getDevelopmentTeam(projectData: IProjectData, teamId?: string): Promise<string> {
 		teamId = teamId || this.readTeamId(projectData);
 

lib/services/ios-provision-service.ts

@@ -29,7 +29,7 @@ export class IOSProvisionService {
 
 		function formatSupportedDeviceCount(prov: mobileprovision.provision.MobileProvision) {
 			if (devices.length > 0 && prov.Type === "Development") {
-				return prov.ProvisionedDevices.reduce((count, device) => count + (devices.indexOf(device) >= 0 ? 1 : 0), 0) + "/" + devices.length + " targets";
+				return prov.ProvisionedDevices.filter(device => devices.indexOf(device) >= 0).length + "/" + devices.length + " targets";
 			} else {
 				return "";
 			}

lib/services/pbxproj-dom-xcode.ts

@@ -0,0 +1,7 @@
+import * as PbxprojDomXcodeModule from "pbxproj-dom/xcode";
+
+declare global {
+    type IPbxprojDomXcode = typeof PbxprojDomXcodeModule;
+}
+
+$injector.register("pbxprojDomXcode", () => require("pbxproj-dom/xcode"), true);

lib/services/platform-service.ts

@@ -293,7 +293,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 			}
 		}
 
-		if (!changesInfo || changesInfo.appResourcesChanged) {
+		if (!changesInfo || changesInfo.changesRequirePrepare) {
 			await this.copyAppFiles(platform, appFilesUpdaterOptions, projectData);
 			this.copyAppResources(platform, projectData);
 			await platformData.platformProjectService.prepareProject(projectData, platformSpecificData);

lib/services/project-changes-service.ts

@@ -11,20 +11,27 @@ class ProjectChangesInfo implements IProjectChangesInfo {
 	public configChanged: boolean;
 	public packageChanged: boolean;
 	public nativeChanged: boolean;
+	public signingChanged: boolean;
 
 	public get hasChanges(): boolean {
 		return this.packageChanged ||
 			this.appFilesChanged ||
 			this.appResourcesChanged ||
 			this.modulesChanged ||
-			this.configChanged;
+			this.configChanged ||
+			this.signingChanged;
 	}
 
 	public get changesRequireBuild(): boolean {
 		return this.packageChanged ||
 			this.appResourcesChanged ||
 			this.nativeChanged;
 	}
+
+	public get changesRequirePrepare(): boolean {
+		return this.appResourcesChanged ||
+			this.signingChanged;
+	}
 }
 
 export class ProjectChangesService implements IProjectChangesService {
@@ -75,16 +82,10 @@ export class ProjectChangesService implements IProjectChangesService {
 				]);
 			}
 		}
-		if (platform.toLowerCase() === this.$devicePlatformsConstants.iOS.toLowerCase()) {
-			const nextCommandProvisionUUID = projectChangesOptions.provision;
-			// We should consider reading here the provisioning profile UUID from the xcodeproj and xcconfig.
-			const prevProvisionUUID = this._prepareInfo.iOSProvisioningProfileUUID;
-			if (nextCommandProvisionUUID !== prevProvisionUUID) {
-				this._changesInfo.nativeChanged = true;
-				this._changesInfo.configChanged = true;
-				this._prepareInfo.iOSProvisioningProfileUUID = nextCommandProvisionUUID;
-			}
-		}
+
+		let projectService = platformData.platformProjectService;
+		projectService.checkForChanges(this._changesInfo, projectChangesOptions, projectData);
+
 		if (projectChangesOptions.bundle !== this._prepareInfo.bundle || projectChangesOptions.release !== this._prepareInfo.release) {
 			this._changesInfo.appFilesChanged = true;
 			this._changesInfo.appResourcesChanged = true;

package.json

@@ -56,7 +56,7 @@
     "mute-stream": "0.0.5",
     "open": "0.0.5",
     "osenv": "0.1.3",
-    "pbxproj-dom": "1.0.9",
+    "pbxproj-dom": "1.0.11",
     "plist": "1.1.0",
     "plist-merge-patch": "0.0.9",
     "plistlib": "0.2.1",
@@ -98,8 +98,8 @@
     "grunt-tslint": "4.0.0",
     "istanbul": "0.4.5",
     "mocha": "3.1.2",
-    "mocha-typescript": "^1.0.4",
     "should": "7.0.2",
+    "source-map-support": "^0.4.14",
     "tslint": "4.3.1",
     "typescript": "2.1.4"
   },

test/ios-project-service.ts

@@ -85,6 +85,7 @@ function createTestInjector(projectPath: string, projectName: string): IInjector
 	testInjector.register("androidProcessService", {});
 	testInjector.register("processService", {});
 	testInjector.register("sysInfo", {});
+	testInjector.register("pbxprojDomXcode", {});
 	return testInjector;
 }
 
@@ -486,3 +487,92 @@ describe("Relative paths", () => {
 		assert.equal(result, path.join("..", "..", "sub", "path"));
 	});
 });
+
+describe("iOS Project Service Signing", () => {
+	let testInjector: IInjector;
+	let projectPath: string;
+	let files: any;
+	let pbxprojects: any;
+	let iOSProjectService: IPlatformProjectService;
+	let projectData: any;
+	let pbxproj: string;
+
+	beforeEach(() => {
+		let projectName = "projectDirectory";
+		files = {};
+		pbxprojects = {};
+		projectPath = temp.mkdirSync(projectName);
+		testInjector = createTestInjector(projectPath, projectName);
+		testInjector.register("fs", {
+			files: {},
+			readJson(path: string): any {
+				if (this.exists(path)) {
+					return JSON.stringify(files[path]);
+				} else {
+					return null;
+				}
+			},
+			exists(path: string): boolean {
+				return path in files;
+			}
+		});
+		testInjector.register("pbxprojDomXcode", {
+			Xcode: {
+				open(path: string) {
+					return pbxprojects[path];
+				}
+			}
+		});
+		pbxproj = path.join(projectPath, "platforms/ios/projectDirectory.xcodeproj/project.pbxproj");
+		iOSProjectService = testInjector.resolve("iOSProjectService");
+		projectData = testInjector.resolve("projectData");
+	});
+
+	describe("Check for Changes", () => {
+		it("sets signingChanged if no Xcode project exists", () => {
+			let changes = <IProjectChangesInfo>{};
+			iOSProjectService.checkForChanges(changes, { bundle: false, release: false, provision: "NativeScriptDev" }, projectData);
+			assert.isTrue(!!changes.signingChanged);
+		});
+		it("sets signingChanged if the Xcode projects is configured with Automatic signing, but proivsion is specified", () => {
+			files[pbxproj] = "";
+			pbxprojects[pbxproj] = {
+				getSigning() {
+					return { style: "Automatic" };
+				}
+			};
+			let changes = <IProjectChangesInfo>{};
+			iOSProjectService.checkForChanges(changes, { bundle: false, release: false, provision: "NativeScriptDev" }, projectData);
+			assert.isTrue(!!changes.signingChanged);
+		});
+		it("sets signingChanged if the Xcode projects is configured with Manual signing, but the proivsion specified differs the selected in the pbxproj", () => {
+			files[pbxproj] = "";
+			pbxprojects[pbxproj] = {
+				getSigning() {
+					return { style: "Manual", configurations: {
+						Debug: { name: "NativeScriptDev2" },
+						Release: { name: "NativeScriptDev2" }
+					}};
+				}
+			};
+			let changes = <IProjectChangesInfo>{};
+			iOSProjectService.checkForChanges(changes, { bundle: false, release: false, provision: "NativeScriptDev" }, projectData);
+			assert.isTrue(!!changes.signingChanged);
+		});
+		it("does not set signingChanged if the Xcode projects is configured with Manual signing and proivsion matches", () => {
+			let pbxproj = path.join(projectPath, "platforms/ios/projectDirectory.xcodeproj/project.pbxproj");
+			files[pbxproj] = "";
+			pbxprojects[pbxproj] = {
+				getSigning() {
+					return { style: "Manual", configurations: {
+						Debug: { name: "NativeScriptDev" },
+						Release: { name: "NativeScriptDev" }
+					}};
+				}
+			};
+			let changes = <IProjectChangesInfo>{};
+			iOSProjectService.checkForChanges(changes, { bundle: false, release: false, provision: "NativeScriptDev" }, projectData);
+			assert.isFalse(!!changes.signingChanged);
+		});
+	});
+});

test/mocha.opts

@@ -1,5 +1,6 @@
 --recursive
 --reporter spec
+--require source-map-support/register
 --require test/test-bootstrap.js
 --timeout 150000
 test/

test/npm-support.ts

@@ -159,7 +159,8 @@ async function setupProject(dependencies?: any): Promise<any> {
 				ensureConfigurationFileInAppResources: (): any => null,
 				interpolateConfigurationFile: (): void => undefined,
 				isPlatformPrepared: (projectRoot: string) => false,
-				validatePlugins: (projectData: IProjectData) => Promise.resolve()
+				validatePlugins: (projectData: IProjectData) => Promise.resolve(),
+				checkForChanges: () => { /* */ }
 			}
 		};
 	};