Skip to content

Commit

Permalink
feat: check npm & node version in testToolChecker (#9967)
Browse files Browse the repository at this point in the history 
* feat: check npm & node version in testToolChecker

* fix: unused imports
  • Loading branch information
@a1exwang
a1exwang authored Sep 18, 2023
1 parent e0310f9 commit d57f156
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 68 deletions.
29 changes: 26 additions & 3 deletions packages/fx-core/src/common/deps-checker/internal/testToolChecker.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import semver from "semver";
import * as uuid from "uuid";
import { ConfigFolderName, err, ok, Result } from "@microsoft/teamsfx-api";
import { getLocalizedString } from "../../localizeUtils";
import { v3DefaultHelpLink } from "../constant/helpLink";
import { v3DefaultHelpLink, v3NodeNotFoundHelpLink } from "../constant/helpLink";
import { Messages } from "../constant/message";
import { DependencyStatus, DepsChecker, DepsType, TestToolInstallOptions } from "../depsChecker";
import { DepsCheckerError } from "../depsError";
import { DepsCheckerError, NodeNotFoundError } from "../depsError";
import { createSymlink, rename, unlinkSymlink, cleanup } from "../util/fileHelper";
import { isWindows } from "../util/system";
import { TelemetryProperties } from "../constant/telemetry";
Expand Down Expand Up @@ -90,6 +90,9 @@ export class TestToolChecker implements DepsChecker {
public async resolve(installOptions: TestToolInstallOptions): Promise<DependencyStatus> {
let installationInfo: TestToolDependencyStatus;
try {
if (!(await this.hasNode())) {
throw new NodeNotFoundError(Messages.NodeNotFound(), v3NodeNotFoundHelpLink);
}
installationInfo = await this.getInstallationInfo(installOptions);
if (!installationInfo.isInstalled) {
const symlinkDir = path.resolve(installOptions.projectPath, installOptions.symlinkDir);
Expand Down Expand Up @@ -124,7 +127,9 @@ export class TestToolChecker implements DepsChecker {
versionRange: string,
symlinkDir: string
): Promise<TestToolDependencyStatus> {
// TODO: check npm installed
if (!(await this.hasNPM())) {
throw new DepsCheckerError(Messages.needInstallNpm(), v3DefaultHelpLink);
}

const tmpVersion = `tmp-${uuid.v4().slice(0, 6)}`;
const tmpPath = this.getPortableInstallPath(tmpVersion);
Expand Down Expand Up @@ -333,6 +338,24 @@ export class TestToolChecker implements DepsChecker {
return output.trim();
}

private async hasNode(): Promise<boolean> {
try {
await cpUtils.executeCommand(undefined, undefined, { shell: true }, "node", "--version");
return true;
} catch (error) {
return false;
}
}

private async hasNPM(): Promise<boolean> {
try {
await cpUtils.executeCommand(undefined, undefined, { shell: true }, "npm", "--version");
return true;
} catch (error) {
return false;
}
}

private async npmInstall(
projectPath: string,
prefix: string,
Expand Down
206 changes: 141 additions & 65 deletions packages/fx-core/tests/common/deps-checker/testToolChecker.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,74 @@ function mockInstallInfoFile(projectPath: string) {
};
}

// input, undefined means failure by default
interface EnvironmentInfo {
nodeVersion?: string;
npmVersion?: string;
testToolVersionBeforeInstall?: string;
testToolVersionAfterInstall?: string;
installSuccess?: boolean;
}

// output
interface EnvironmentStatus {
npmInstalled: boolean;
npmInstallArgs?: string[];
}

// mock environment for simpler cases.
// for complex cases, mock executeCommand directly
function mockEnvironment(sandbox: sinon.SinonSandbox, info: EnvironmentInfo): EnvironmentStatus {
const status: EnvironmentStatus = {
npmInstalled: false,
};
sandbox.stub(fileHelper, "rename").resolves();
sandbox.stub(fileHelper, "createSymlink").resolves();
sandbox
.stub(cpUtils, "executeCommand")
.callsFake(async (_cwd, _logger, _options, command, ...args) => {
command = trimQuotes(command);
args = args.map(trimQuotes);
if (command === "node" && args.includes("--version")) {
if (info.nodeVersion === undefined) {
throw new Error("not found");
} else {
return info.nodeVersion;
}
} else if (command === "npm" && args.includes("--version")) {
if (info.npmVersion === undefined) {
throw new Error("not found");
} else {
return info.npmVersion;
}
} else if (command.includes("teamsapptester") && args.includes("--version")) {
if (status.npmInstalled) {
if (info.testToolVersionAfterInstall === undefined) {
throw new Error("not found");
} else {
return info.testToolVersionAfterInstall;
}
} else {
if (info.testToolVersionBeforeInstall === undefined) {
throw new Error("not found");
} else {
return info.testToolVersionBeforeInstall;
}
}
} else if (command === "npm" && args.includes("install")) {
if (info.installSuccess) {
status.npmInstalled = true;
status.npmInstallArgs = args;
return "";
} else {
throw new Error("failed to npm install");
}
}
throw new Error("Command not mocked");
});
return status;
}

describe("Test Tool Checker Test", () => {
const sandbox = sinon.createSandbox();
const projectPath = "projectPath";
Expand All @@ -53,28 +121,17 @@ describe("Test Tool Checker Test", () => {
const checker = new TestToolChecker();
const symlinkDir = "symlinkDir";
const versionRange = "~1.2.3";
let npmInstalled = false;
mockfs({});
const writtenFiles: string[] = [];
sandbox.stub(fs, "writeJson").callsFake((path) => {
writtenFiles.push(path);
});
sandbox.stub(fileHelper, "rename").resolves();
sandbox.stub(fileHelper, "createSymlink").resolves();
sandbox
.stub(cpUtils, "executeCommand")
.callsFake(async (_cwd, _logger, _options, command, ...args) => {
if (args.includes("--version")) {
if (npmInstalled) {
return "1.2.3";
} else {
throw new Error("not installed");
}
} else if (args.includes("install")) {
npmInstalled = true;
}
return "";
});
const envStatus = mockEnvironment(sandbox, {
nodeVersion: "v18.16.1",
npmVersion: "9.5.1",
installSuccess: true,
testToolVersionBeforeInstall: undefined,
testToolVersionAfterInstall: "1.2.3",
});

// Act
const status = await checker.resolve({ projectPath, symlinkDir, versionRange });
Expand All @@ -83,7 +140,7 @@ describe("Test Tool Checker Test", () => {
expect(status.isInstalled).to.be.true;
expect(status.details.binFolders).not.empty;
expect(status.error).to.be.undefined;
expect(npmInstalled).to.be.true;
expect(envStatus.npmInstalled).to.be.true;
expect(writtenFiles.map((f) => path.resolve(f))).to.include(
path.resolve(path.join(projectPath, "devTools", ".testTool.installInfo.json"))
);
Expand All @@ -95,20 +152,14 @@ describe("Test Tool Checker Test", () => {
const checker = new TestToolChecker();
const symlinkDir = "symlinkDir";
const versionRange = "~1.2.3";
let npmInstalled = false;
mockfs({
...mockInstallInfoFile(projectPath),
});
sandbox
.stub(cpUtils, "executeCommand")
.callsFake(async (_cwd, _logger, _options, command, ...args) => {
if (args.includes("--version")) {
return "1.2.3";
} else if (args.includes("install")) {
npmInstalled = true;
}
return "";
});
const envStatus = mockEnvironment(sandbox, {
nodeVersion: "v18.16.1",
npmVersion: "9.5.1",
testToolVersionBeforeInstall: "1.2.3",
});

// Act
const status = await checker.resolve({ projectPath, symlinkDir, versionRange });
Expand All @@ -117,7 +168,7 @@ describe("Test Tool Checker Test", () => {
expect(status.isInstalled).to.be.true;
expect(status.details.binFolders).not.empty;
expect(status.error).to.be.undefined;
expect(npmInstalled).to.be.false;
expect(envStatus.npmInstalled).to.be.false;
});

it("Already installed in home", async () => {
Expand Down Expand Up @@ -269,23 +320,13 @@ describe("Test Tool Checker Test", () => {
const checker = new TestToolChecker();
const symlinkDir = "symlinkDir";
const versionRange = "~1.2.3";
let npmInstalled = false;
sandbox.stub(fileHelper, "rename").resolves();
sandbox.stub(fileHelper, "createSymlink").resolves();
sandbox
.stub(cpUtils, "executeCommand")
.callsFake(async (_cwd, _logger, _options, command, ...args) => {
if (args.includes("--version")) {
if (npmInstalled) {
return "1.2.3";
} else {
return "1.2.2";
}
} else if (args.includes("install")) {
npmInstalled = true;
}
return "";
});
const envStatus = mockEnvironment(sandbox, {
nodeVersion: "v18.16.1",
npmVersion: "9.5.1",
testToolVersionBeforeInstall: "1.2.2",
testToolVersionAfterInstall: "1.2.3",
installSuccess: true,
});

// Act
const status = await checker.resolve({ projectPath, symlinkDir, versionRange });
Expand All @@ -294,7 +335,7 @@ describe("Test Tool Checker Test", () => {
expect(status.isInstalled).to.be.true;
expect(status.details.binFolders).not.empty;
expect(status.error).to.be.undefined;
expect(npmInstalled).to.be.true;
expect(envStatus.npmInstalled).to.be.true;
});
it("Already installed in home, but version not match", async () => {
const checker = new TestToolChecker();
Expand Down Expand Up @@ -389,31 +430,26 @@ describe("Test Tool Checker Test", () => {
mockfs({
[path.join(mockProjectPath, "microsoft-teams-app-test-tool-cli-1.2.3.tgz")]: "",
});
let installArgs: string[] = [];
sandbox.stub(fileHelper, "rename").resolves();
sandbox.stub(fileHelper, "createSymlink").resolves();
sandbox
.stub(cpUtils, "executeCommand")
.callsFake(async (_cwd, _logger, _options, command, ...args) => {
if (args.includes("--version")) {
throw new Error("not installed");
} else if (args.includes("install")) {
installArgs = args;
}
return "";
});
const envStatus = mockEnvironment(sandbox, {
nodeVersion: "v18.16.1",
npmVersion: "9.5.1",
testToolVersionBeforeInstall: undefined,
testToolVersionAfterInstall: "1.2.3",
installSuccess: true,
});

// Act
await checker.resolve({ projectPath, symlinkDir, versionRange });

// Assert
const fileArg = installArgs.filter((arg) =>
expect(envStatus.npmInstallArgs).not.undefined;
const fileArg = envStatus.npmInstallArgs?.filter((arg) =>
arg.includes("microsoft-teams-app-test-tool-cli")
)[0];
)?.[0];
expect(fileArg).not.empty;
let parsed: url.URL | undefined;
expect(() => {
parsed = new url.URL(trimQuotes(fileArg));
parsed = new url.URL(fileArg!);
}).not.throw();
expect(parsed).not.undefined;
expect(parsed?.protocol).equals("file:");
Expand Down Expand Up @@ -564,6 +600,8 @@ describe("Test Tool Checker Test", () => {
.stub(cpUtils, "executeCommand")
.callsFake(async (_cwd, _logger, _options, command, ...args) => {
if (args.includes("--version")) {
if (command === "node") return "v18.16.1";
if (command === "npm") return "9.5.1";
if (checkedUpdate) {
// after update
throw new Error("Update failed");
Expand Down Expand Up @@ -629,4 +667,42 @@ describe("Test Tool Checker Test", () => {
expect(status.details.installVersion).to.eq("1.2.3");
});
});

describe("Prerequisites", () => {
it("Node not found", async () => {
const checker = new TestToolChecker();
const symlinkDir = "symlinkDir";
const versionRange = "1.2.3";
mockEnvironment(sandbox, { nodeVersion: undefined, npmVersion: "9.5.1" });
// Act
const status = await checker.resolve({
projectPath,
symlinkDir,
versionRange,
});
// Assert
expect(status.isInstalled).to.be.false;
expect(status.details.binFolders).be.empty;
expect(status.error).not.undefined;
expect(status.error?.message).match(/node/i);
});
it("Npm not found", async () => {
const checker = new TestToolChecker();
const symlinkDir = "symlinkDir";
const versionRange = "1.2.3";
mockfs({});
mockEnvironment(sandbox, { nodeVersion: "v18.16.1", npmVersion: undefined });
// Act
const status = await checker.resolve({
projectPath,
symlinkDir,
versionRange,
});
// Assert
expect(status.isInstalled).to.be.false;
expect(status.details.binFolders).be.empty;
expect(status.error).not.undefined;
expect(status.error?.message).match(/npm/i);
});
});
});

0 comments on commit d57f156

Please sign in to comment.