Added tests for the CLI

Author: JamesMessinger

src/options.ts

@@ -32,7 +32,7 @@ export interface Options {
   checkVersion?: boolean;
 
   /**
-   * Suppress console output from NPM.
+   * Suppress console output from NPM and npm-publish.
    *
    * Defaults to `false`
    */

test/specs/cli/args.spec.js

@@ -0,0 +1,142 @@
+"use strict";
+
+const npm = require("../../utils/npm");
+const files = require("../../utils/files");
+const exec = require("../../utils/exec");
+const { expect } = require("chai");
+const manifest = require("../../../package.json");
+
+describe("CLI - argument tests", () => {
+
+  it("should error if an invalid argument is used", () => {
+    let cli = exec.cli("--debug", "--help", "--fizzbuzz", "--quiet");
+
+    expect(cli).to.have.exitCode(9);
+    expect(cli).to.have.stdout("");
+    expect(cli.stderr).to.match(/^Unknown option: --fizzbuzz\n\nUsage: npm-publish \[options\] \[package_path\]\n/);
+  });
+
+  it("should error if an invalid shorthand argument is used", () => {
+    let cli = exec.cli("-dqzv");
+
+    expect(cli).to.have.exitCode(9);
+    expect(cli).to.have.stdout("");
+    expect(cli.stderr).to.match(/^Unknown option: -z\n\nUsage: npm-publish \[options\] \[package_path\]\n/);
+  });
+
+  it("should print a more detailed error if DEBUG is set", () => {
+    process.env.DEBUG = "true";
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).to.have.exitCode(1);
+
+    expect(cli).to.have.stderr.that.matches(/^Error: Unable to read package.json \nENOENT: no such file or directory/);
+    expect(cli).to.have.stderr.that.matches(/\n    at /);
+
+    process.env.DEBUG = "";
+  });
+
+  describe("npm-publish --help", () => {
+    it("should show usage text", () => {
+      let cli = exec.cli("--help");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli.stdout).to.match(/^\nUsage: npm-publish \[options\] \[package_path\]\n/);
+    });
+
+    it("should support -h shorthand", () => {
+      let cli = exec.cli("-h");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli.stdout).to.match(/^\nUsage: npm-publish \[options\] \[package_path\]\n/);
+    });
+
+    it("should ignore other arguments", () => {
+      let cli = exec.cli("--quiet", "--help", "--version");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli.stdout).to.match(/^\nUsage: npm-publish \[options\] \[package_path\]\n/);
+    });
+
+    it("should ignore other shorthand arguments", () => {
+      let cli = exec.cli("-dhv");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli.stdout).to.match(/^\nUsage: npm-publish \[options\] \[package_path\]\n/);
+    });
+  });
+
+  describe("npm-publish --version", () => {
+    it("should show the version number", () => {
+      let cli = exec.cli("--version");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli).to.have.stdout(manifest.version + "\n");
+    });
+
+    it("should support -v shorthand", () => {
+      let cli = exec.cli("-v");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli).to.have.stdout(manifest.version + "\n");
+    });
+
+    it("should ignore other arguments", () => {
+      let cli = exec.cli("--quiet", "--version", "--debug");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli).to.have.stdout(manifest.version + "\n");
+    });
+
+    it("should ignore other shorthand arguments", () => {
+      let cli = exec.cli("-dvq");
+
+      expect(cli).to.have.exitCode(0);
+      expect(cli).to.have.stderr("");
+      expect(cli).to.have.stdout(manifest.version + "\n");
+    });
+  });
+
+  describe("npm-publish --token", () => {
+    it("should error if the --token is missing its value", () => {
+      let cli = exec.cli("--quiet", "--token", "--version");
+
+      expect(cli).to.have.exitCode(9);
+      expect(cli).to.have.stdout("");
+      expect(cli.stderr).to.match(/^The --token argument requires a value\n\nUsage: npm-publish \[options\] \[package_path\]\n/);
+    });
+  });
+
+  describe("npm-publish --registry", () => {
+    it("should error if the --registry is missing its value", () => {
+      let cli = exec.cli("--quiet", "--registry", "--version");
+
+      expect(cli).to.have.exitCode(9);
+      expect(cli).to.have.stdout("");
+      expect(cli.stderr).to.match(/^The --registry argument requires a value\n\nUsage: npm-publish \[options\] \[package_path\]\n/);
+    });
+
+    it("should fail if the NPM registry URL is invalid", () => {
+      files.create([
+        { path: "workspace/package.json", contents: { name: "my-lib", version: "1.2.3" }},
+      ]);
+
+      let cli = exec.cli("--registry", "example.com");
+
+      expect(cli).to.have.stdout("");
+      expect(cli).stderr.to.include("Invalid URL: example.com");
+      expect(cli).to.have.exitCode(1);
+
+      files.assert.doesNotExist("home/.npmrc");
+      npm.assert.ran(0);
+    });
+  });
+});

test/specs/cli/failure.spec.js

@@ -0,0 +1,178 @@
+"use strict";
+
+const npm = require("../../utils/npm");
+const files = require("../../utils/files");
+const paths = require("../../utils/paths");
+const exec = require("../../utils/exec");
+const { expect } = require("chai");
+const { EOL } = require("os");
+
+describe("CLI - failure tests", () => {
+
+  it("should fail if the package.json file does not exist", () => {
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).stderr.to.include("Unable to read package.json \nENOENT: no such file or directory");
+    expect(cli).to.have.exitCode(1);
+
+    files.assert.doesNotExist("home/.npmrc");
+    files.assert.doesNotExist("workspace/package.json");
+    npm.assert.didNotRun();
+  });
+
+  it("should fail if the package.json file is invalid", () => {
+    files.create([
+      { path: "workspace/package.json", contents: "hello, world" },
+    ]);
+
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).to.have.stderr("Unable to parse package.json \nUnexpected token h in JSON at position 0\n");
+    expect(cli).to.have.exitCode(1);
+
+    files.assert.doesNotExist("home/.npmrc");
+    npm.assert.didNotRun();
+  });
+
+  it("should fail if the package name is invalid", () => {
+    files.create([
+      { path: "workspace/package.json", contents: { name: "\n  \t" }},
+    ]);
+
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).to.have.stderr("Unable to parse package.json \nInvalid package name\n");
+    expect(cli).to.have.exitCode(1);
+
+    files.assert.doesNotExist("home/.npmrc");
+    npm.assert.didNotRun();
+  });
+
+  it("should fail if the package version is invalid", () => {
+    files.create([
+      { path: "workspace/package.json", contents: { name: "my-lib", version: "hello, world" }},
+    ]);
+
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).to.have.stderr("Unable to parse package.json \nInvalid Version: hello, world\n");
+    expect(cli).to.have.exitCode(1);
+
+    files.assert.doesNotExist("home/.npmrc");
+    npm.assert.didNotRun();
+  });
+
+  it('should fail if the "npm view" command errors', () => {
+    files.create([
+      { path: "workspace/package.json", contents: { name: "my-lib", version: "2.0.0" }},
+    ]);
+
+    npm.mock({
+      args: ["view", "my-lib", "version"],
+      stderr: "BOOM!",
+      exitCode: 1,
+    });
+
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).to.have.stderr(
+      "Unable to determine the current version of my-lib on NPM. \n" +
+      "npm view my-lib version exited with a status of 1.\n\n" +
+      "BOOM!\n"
+    );
+    expect(cli).to.have.exitCode(1);
+
+    npm.assert.ran(1);
+  });
+
+  it("should fail if the .npmrc file is invalid", () => {
+    files.create([
+      { path: "workspace/package.json", contents: { name: "my-lib", version: "2.0.0" }},
+      { path: "home/.npmrc/file.txt", contents: "~/.npmrc is a directory, not a file" },
+    ]);
+
+    npm.mock({
+      args: ["view", "my-lib", "version"],
+      stdout: `1.0.0${EOL}`,
+    });
+
+    npm.mock({
+      args: ["config", "get", "userconfig"],
+      stdout: `${paths.npmrc}${EOL}`,
+    });
+
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).stderr.to.include("Unable to read the NPM config file: ");
+    expect(cli).stderr.to.include("EISDIR: illegal operation on a directory, read");
+    expect(cli).to.have.exitCode(1);
+
+    npm.assert.ran(2);
+  });
+
+  it('should fail if the "npm config" command errors', () => {
+    files.create([
+      { path: "workspace/package.json", contents: { name: "my-lib", version: "2.0.0" }},
+    ]);
+
+    npm.mock({
+      args: ["view", "my-lib", "version"],
+      stdout: `1.0.0${EOL}`,
+    });
+
+    npm.mock({
+      args: ["config", "get", "userconfig"],
+      stderr: "BOOM!",
+      exitCode: 1,
+    });
+
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).stderr.to.include("Unable to determine the NPM config file path.");
+    expect(cli).stderr.to.include("npm config get userconfig exited with a status of 1");
+    expect(cli).stderr.to.include("BOOM!");
+    expect(cli).to.have.exitCode(1);
+
+    npm.assert.ran(2);
+  });
+
+  it('should fail if the "npm publish" command errors', () => {
+    files.create([
+      { path: "workspace/package.json", contents: { name: "my-lib", version: "2.0.0" }},
+    ]);
+
+    npm.mock({
+      args: ["view", "my-lib", "version"],
+      stdout: `1.0.0${EOL}`,
+    });
+
+    npm.mock({
+      args: ["config", "get", "userconfig"],
+      stdout: `${paths.npmrc}${EOL}`,
+    });
+
+    npm.mock({
+      args: ["publish"],
+      stderr: "BOOM!",
+      exitCode: 1,
+    });
+
+    let cli = exec.cli();
+
+    expect(cli).to.have.stdout("");
+    expect(cli).stderr.to.include("Unable to publish my-lib v2.0.0 to NPM.");
+    expect(cli).stderr.to.include("npm publish exited with a status of 1");
+    expect(cli).stderr.to.include("BOOM!");
+    expect(cli).to.have.exitCode(1);
+
+    npm.assert.ran(3);
+  });
+
+});