test: adding some unit tests

Author: amphro

.gitignore

@@ -5,5 +5,6 @@
 /lib
 /package-lock.json
 /tmp
+/test/tmp
 node_modules
 oclif.manifest.json

package.json

@@ -20,7 +20,8 @@
     "@oclif/plugin-help": "^2",
     "@oclif/test": "^1",
     "globby": "^8",
-    "husky": "^1"
+    "husky": "^1",
+    "salesforcedx": "48.3.1"
   },
   "engines": {
     "node": ">=8.4.0"
@@ -47,7 +48,8 @@
       }
     },
     "devPlugins": [
-      "@oclif/plugin-help"
+      "@oclif/plugin-help",
+      "salesforcedx"
     ]
   },
   "repository": "salesforcecli/plugin-command-reference",

src/docs.ts

@@ -37,23 +37,13 @@ export class Docs {
     private topicMeta: JsonMap
   ) {}
 
-  /**
-   * Take CLI help json output and transform into dita map format
-   * @param options - array of command line options (args)
-   */
   public async build(commands: JsonMap[]) {
     // Create if doesn't exist
     await fs.mkdirp(this.outputDir);
 
     await this.populateTemplate(commands);
   }
 
-  /**
-   * Create the descriptor xml file for the main level topic
-   * @param namespace
-   * @param results
-   * @param rootOutputDir
-   */
   public async populateTopic(topic: string, subtopics: Dictionary<Dictionary | Dictionary[]>) {
     const topicMeta = ensureJsonMap(this.topicMeta[topic]);
     let description = asString(topicMeta.longDescription);
@@ -127,17 +117,14 @@ export class Docs {
     // The topic ditamap with all of the subtopic links.
     events.emit('subtopics', topic, subTopicNames);
     await new TopicDitamap(topic, subTopicNames, commandNames).write();
-
-    // TODO just include it in the upper loop?
-    // await this.populateSubTopics(topic, subtopics)
     return subTopicNames;
   }
 
   /**
    * Group all commands by the top level topic and then subtopic. e.g. force, analytics, evergreen, etc
    * then org, apex, etc within the force namespace.
    * @param commands - The entire set of command data.
-   * @returns The commands grouped by namespace grouped by topics/commands.
+   * @returns The commands grouped by topics/subtopic/commands.
    */
   private groupTopicsAndSubtopics(commands: JsonMap[]) {
     const topLevelTopics: Dictionary<Dictionary<Dictionary | Dictionary[]>> = {};
@@ -192,12 +179,6 @@ export class Docs {
     return topLevelTopics;
   }
 
-  /**
-   * Given help data in json convert it to ditamap format
-   * @param outputdir - directory for ditamap format results
-   * @param showhidden - include hidden parameters in converted help
-   * @param parsedData - {object} containing CLI help
-   */
   private async populateTemplate(commands: JsonMap[]) {
     const topicsAndSubtopics = this.groupTopicsAndSubtopics(commands);
 

test/endtoend.test.ts

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2018, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { fs } from '@salesforce/core';
+import { expect } from 'chai';
+import { readFileSync } from 'fs';
+import { join } from 'path';
+
+/**
+ * This plugin was primarily made to generate command reference docs for
+ * salesforcedx. Generate actual docs and ensure some of the files are generated
+ * correctly. If there is new code added to fix a new bug that relies on a new
+ * version of salesforcedx, updated it in the package.json. To add test for other
+ * plugins, it would probably be best to create a base test to generate the docs
+ * for the test cases to reference.
+ */
+
+const testFilesPath = './test/tmp';
+
+function loadTestDitamapFile(path: string) {
+  return readFileSync(join(testFilesPath, path), 'utf8');
+}
+
+describe('salesforcedx', () => {
+  before(async () => {
+    await require('@oclif/command').run([
+      'commandreference:generate',
+      '--plugins',
+      'salesforcedx',
+      '--outputdir',
+      testFilesPath
+    ]);
+  });
+  after(async () => {
+    await fs.remove(testFilesPath);
+  });
+
+  it('creates closed-pilot commands', async () => {
+    const dita = loadTestDitamapFile(join('force', 'org', 'cli_reference_force_org_shape_create.xml'));
+    expect(/invitation-only\s+pilot\s+program/.test(dita)).to.be.true;
+  });
+  it('creates beta commands', async () => {
+    const dita = loadTestDitamapFile(join('force', 'org', 'cli_reference_force_org_clone.xml'));
+    expect(/a\s+beta\s+version\s+of\s+the/.test(dita)).to.be.true;
+  });
+  it('creates open-pilot commands', async () => {
+    const dita = loadTestDitamapFile(join('force', 'package', 'cli_reference_force_package_hammertest_run.xml'));
+    expect(/through\s+a\s+pilot\s+program\s+that\s+requires/.test(dita)).to.be.true;
+  });
+  it('creates with long description', async () => {
+    const dita = loadTestDitamapFile(join('force', 'source', 'cli_reference_force_source_push.xml'));
+    expect(/shortdesc">Pushes changed/.test(dita)).to.be.true;
+  });
+});