grafana/toolkit: test improvements and show stats (#18137, #18138)

* Enable running tests in watch mode and by path or name regex

* Toolkit readme update

* Show webpack stats on successful compilation

* unzip the plugin, not the docs

packages/grafana-toolkit/README.md

@@ -35,6 +35,9 @@ Runs Jest against your codebase. See [Tests](#tests) for more details.
 Available options:
 - `-u, --updateSnapshot` - performs snapshots update
 - `--coverage` - reports code coverage
+- `--watch` - runs tests in interactive watch mode
+- `--testNamePattern=<regex>` - runs test with names that match provided regex (https://jestjs.io/docs/en/cli#testnamepattern-regex)
+- `--testPathPattern=<regex>` - runs test with paths that match provided regex (https://jestjs.io/docs/en/cli#testpathpattern-regex)
 
 #### `grafana-toolkit plugin:dev`
 Compiles plugin in development mode.

packages/grafana-toolkit/src/cli/index.ts

@@ -139,11 +139,17 @@ export const run = (includeInternalScripts = false) => {
     .command('plugin:test')
     .option('-u, --updateSnapshot', 'Run snapshots update')
     .option('--coverage', 'Run code coverage')
+    .option('--watch', 'Run tests in interactive watch mode')
+    .option('--testPathPattern <regex>', 'Run only tests with a path that matches the regex')
+    .option('--testNamePattern <regex>', 'Run only tests with a name that matches the regex')
     .description('Executes plugin tests')
     .action(async cmd => {
       await execTask(pluginTestTask)({
         updateSnapshot: !!cmd.updateSnapshot,
         coverage: !!cmd.coverage,
+        watch: !!cmd.watch,
+        testPathPattern: cmd.testPathPattern,
+        testNamePattern: cmd.testNamePattern,
       });
     });
 

packages/grafana-toolkit/src/cli/tasks/plugin.build.ts

@@ -158,9 +158,8 @@ export const pluginBuildRunner: TaskRunner<PluginBuildOptions> = async ({ covera
   await clean();
   await prepare();
   await prettierCheckPlugin({ fix: false });
-  // @ts-ignore
   await lintPlugin({ fix: false });
-  await testPlugin({ updateSnapshot: false, coverage });
+  await testPlugin({ updateSnapshot: false, coverage, watch: false });
   await bundlePlugin({ watch: false, production: true });
 };
 

packages/grafana-toolkit/src/cli/tasks/plugin.ci.ts

@@ -229,8 +229,14 @@ const bundlePluginRunner: TaskRunner<PluginCIOptions> = async () => {
     console.warn('Unable to read SHA1 Checksum');
   }
 
+  console.log('Setup Grafan Environment');
+  let p = path.resolve(grafanaEnvDir, 'plugins', pluginInfo.id);
+  fs.mkdirSync(p, { recursive: true });
+  await execa('unzip', [zipFile, '-d', p]);
+
   // If docs exist, zip them into artifacts
   if (fs.existsSync(docsDir)) {
+    console.log('Creating documentation zip');
     zipName = pluginInfo.id + '-' + pluginInfo.info.version + '-docs.zip';
     zipFile = path.resolve(artifactsDir, zipName);
     process.chdir(docsDir);
@@ -254,18 +260,13 @@ const bundlePluginRunner: TaskRunner<PluginCIOptions> = async () => {
     info.docs = zipInfo;
   }
 
-  let p = path.resolve(artifactsDir, 'info.json');
+  p = path.resolve(artifactsDir, 'info.json');
   fs.writeFile(p, JSON.stringify(info, null, 2), err => {
     if (err) {
       throw new Error('Error writing artifact info: ' + p);
     }
   });
 
-  console.log('Setup Grafan Environment');
-  p = path.resolve(grafanaEnvDir, 'plugins', pluginInfo.id);
-  fs.mkdirSync(p, { recursive: true });
-  await execa('unzip', [zipFile, '-d', p]);
-
   // Write the custom settings
   p = path.resolve(grafanaEnvDir, 'custom.ini');
   const customIniBody =

packages/grafana-toolkit/src/cli/tasks/plugin/bundle.ts

@@ -33,12 +33,14 @@ export const bundlePlugin = async ({ watch, production }: PluginBundleOptions) =
         const output = formatWebpackMessages(stats.toJson());
 
         if (!output.errors.length && !output.warnings.length) {
-          console.log('Compiled successfully!');
+          console.log('Compiled successfully!\n');
+          console.log(stats.toString({ colors: true }));
         }
 
         if (output.errors.length) {
           console.log('Compilation failed!');
           output.errors.forEach(e => console.log(e));
+
           if (output.warnings.length) {
             console.log('Warnings:');
             output.warnings.forEach(w => console.log(w));
@@ -61,6 +63,7 @@ export const bundlePlugin = async ({ watch, production }: PluginBundleOptions) =
 
           reject('Build failed');
         }
+        console.log('\n', stats.toString({ colors: true }), '\n');
         resolve();
       });
     }

packages/grafana-toolkit/src/cli/tasks/plugin/tests.ts

@@ -5,22 +5,38 @@ import { jestConfig } from '../../../config/jest.plugin.config';
 export interface PluginTestOptions {
   updateSnapshot: boolean;
   coverage: boolean;
+  watch: boolean;
+  testPathPattern?: string;
+  testNamePattern?: string;
 }
 
-export const testPlugin = useSpinner<PluginTestOptions>('Running tests', async ({ updateSnapshot, coverage }) => {
-  const testConfig = jestConfig();
+export const testPlugin = useSpinner<PluginTestOptions>(
+  'Running tests',
+  async ({ updateSnapshot, coverage, watch, testPathPattern, testNamePattern }) => {
+    const testConfig = jestConfig();
 
-  const cliConfig = {
-    config: JSON.stringify(testConfig),
-    updateSnapshot,
-    coverage,
-    passWithNoTests: true,
-  };
+    const cliConfig = {
+      config: JSON.stringify(testConfig),
+      updateSnapshot,
+      coverage,
+      watch,
+      testPathPattern: testPathPattern ? [testPathPattern] : [],
+      testNamePattern: testNamePattern ? [testNamePattern] : [],
+      passWithNoTests: true,
+    };
 
-  // @ts-ignore
-  const results = await jestCLI.runCLI(cliConfig, [process.cwd()]);
+    // @ts-ignore
+    const runJest = () => jestCLI.runCLI(cliConfig, [process.cwd()]);
 
-  if (results.results.numFailedTests > 0 || results.results.numFailedTestSuites > 0) {
-    throw new Error('Tests failed');
+    if (watch) {
+      runJest();
+    } else {
+      // @ts-ignore
+      const results = await runJest();
+
+      if (results.results.numFailedTests > 0 || results.results.numFailedTestSuites > 0) {
+        throw new Error('Tests failed');
+      }
+    }
   }
-});
+);