Merge pull request #32 from badsyntax/fix-gradle-stdout-parsing

Fix gradle tasks parsing. Fixes #19

Author: badsyntax

.vscode/launch.json

@@ -95,6 +95,20 @@
       ],
       "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
       "preLaunchTask": "npm: watch"
+    },
+    {
+      "name": "Test: Unit",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--extensionTestsPath=${workspaceFolder}/out/test/unit/",
+        "${workspaceFolder}/test-fixtures/gradle-groovy-default-build-file"
+      ],
+      "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+      "preLaunchTask": "npm: watch"
     }
   ]
 }

src/extension.ts

@@ -113,10 +113,7 @@ export async function activate(
 ): Promise<ExtensionApi> {
   registerTaskProvider(context);
   treeDataProvider = registerExplorer(context);
-  const hasBuildFile = await hasGradleBuildFile();
-  if (!hasBuildFile) {
-    window.showWarningMessage('No gradle build file found');
-  } else if (getIsTasksExplorerEnabled()) {
+  if ((await hasGradleBuildFile()) && getIsTasksExplorerEnabled()) {
     commands.executeCommand('setContext', 'gradle:showTasksExplorer', true);
   }
   return {};

src/tasks.ts

@@ -334,23 +334,18 @@ async function exists(file: string): Promise<boolean> {
 
 type StringMap = { [s: string]: string };
 
-const TASK_REGEX: RegExp = /$\s*([a-z0-9]+)(\s-\s(.*))?$/gim;
+const TASK_REGEX: RegExp = /$\s*([a-z]+[A-Z0-9]?[a-z0-9]*[A-Za-z0-9]*)(\s-\s(.*))?/gm;
 
-function parseGradleTasks(buffer: Buffer | string): StringMap {
+export function parseGradleTasks(buffer: Buffer | string): StringMap {
   const tasks: StringMap = {};
   let match: RegExpExecArray | null = null;
   while ((match = TASK_REGEX.exec(buffer.toString())) !== null) {
-    const [, name, description] = match;
+    const [, name, , description] = match;
     tasks[name] = description;
   }
   return tasks;
 }
 
-interface ProcessOutput {
-  readonly stdout: string | Buffer;
-  readonly stderr: string | Buffer;
-}
-
 function spawn(
   command: string,
   args?: ReadonlyArray<string>,

src/test/runTest.ts

@@ -4,6 +4,20 @@ import { runTests } from 'vscode-test';
 
 const extensionDevelopmentPath = path.resolve(__dirname, '../../');
 
+async function runUnitTests() {
+  await runTests({
+    extensionDevelopmentPath,
+    extensionTestsPath: path.resolve(__dirname, 'unit'),
+    launchArgs: [
+      path.resolve(
+        __dirname,
+        '../../test-fixtures/gradle-groovy-default-build-file'
+      ),
+      '--disable-extensions'
+    ]
+  });
+}
+
 async function runTestsWithGradle() {
   const fixtures = [
     'gradle-groovy-default-build-file',
@@ -13,7 +27,7 @@ async function runTestsWithGradle() {
   for (const fixture of fixtures) {
     await runTests({
       extensionDevelopmentPath,
-      extensionTestsPath: path.resolve(__dirname, './gradle'),
+      extensionTestsPath: path.resolve(__dirname, 'gradle'),
       launchArgs: [
         path.resolve(__dirname, `../../test-fixtures/${fixture}`),
         '--disable-extensions'
@@ -28,7 +42,7 @@ async function runTestsWithGradle() {
 async function runTestsWithoutGradle() {
   await runTests({
     extensionDevelopmentPath,
-    extensionTestsPath: path.resolve(__dirname, './no-gradle'),
+    extensionTestsPath: path.resolve(__dirname, 'no-gradle'),
     launchArgs: [
       path.resolve(__dirname, '../../test-fixtures/no-gradle'),
       '--disable-extensions'
@@ -39,7 +53,7 @@ async function runTestsWithoutGradle() {
 async function runTestsWithMultiRoot() {
   await runTests({
     extensionDevelopmentPath,
-    extensionTestsPath: path.resolve(__dirname, './multi-root'),
+    extensionTestsPath: path.resolve(__dirname, 'multi-root'),
     launchArgs: [
       path.resolve(
         __dirname,
@@ -55,6 +69,7 @@ async function runTestsWithMultiRoot() {
 
 async function main() {
   try {
+    await runUnitTests();
     await runTestsWithGradle();
     await runTestsWithMultiRoot();
     await runTestsWithoutGradle();

src/test/unit/index.ts

@@ -0,0 +1,3 @@
+import { createTestRunner } from '../testUtil';
+
+export const run = createTestRunner('**/**.test.js');

src/test/unit/tasks.test.ts

@@ -0,0 +1,32 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import * as assert from 'assert';
+import * as vscode from 'vscode';
+
+import { parseGradleTasks } from '../../tasks';
+
+suite('tasks', () => {
+  suite('gradle tasks output parsing', () => {
+    test('should correctly parse tasks', async () => {
+      const stdout = fs.readFileSync(
+        path.resolve(
+          __dirname,
+          '../../../test-fixtures/unit/gradle-tasks-stdout'
+        ),
+        'utf8'
+      );
+      const tasks = parseGradleTasks(stdout);
+
+      assert.equal(Object.keys(tasks).length, 4);
+      assert.equal('help' in tasks, true);
+      assert.equal('run' in tasks, true);
+      assert.equal('runShadow' in tasks, true);
+      assert.equal('startShadowScripts' in tasks, true);
+
+      assert.equal(tasks.help, undefined);
+      assert.equal(tasks.run, 'Runs a task');
+      assert.equal(tasks.runShadow, 'Runs a shadow task');
+      assert.equal(tasks.startShadowScripts, 'Starts a shadow script');
+    });
+  });
+});

test-fixtures/unit/gradle-tasks-stdout

@@ -0,0 +1,25 @@
+Starting a Gradle Daemon, 12 busy Daemons could not be reused, use --status for details
+
+> Task :tasks
+
+------------------------------------------------------------
+Tasks runnable from root project
+------------------------------------------------------------
+
+Group Description
+-----------------
+run - Runs a task
+runShadow - Runs a shadow task
+startShadowScripts - Starts a shadow script
+help
+
+Rules
+-----
+Pattern: clean<TaskName>: Cleans the output files of a task.
+
+To see all tasks and more detail, run gradlew tasks --all
+
+To see more detail about a task, run gradlew help --task <task>
+
+BUILD SUCCESSFUL in 5s
+1 actionable task: 1 executed