Store file extension configuration next to your DataPlugin (#22)

* Better file extension handling

* Store file extensions on first save

* Readme adjusted

* Initial unit test for file-utils

* Work on e2e tests

Author: jschumme

README.md

@@ -16,7 +16,7 @@ A [Visual Studio Code](https://code.visualstudio.com/) extension that provides d
 ```
 NI DataPlugins: Create new Python-DataPlugin
 ```
-**Step 3.** Export the DataPlugin. Right click on the \*.py file you want to export -> Choose "NI DataPlugins: Export DataPlugin".
+**Step 3.** Export the DataPlugin. Right click on the \*.py file you want to export -> Choose "NI DataPlugins: Export DataPlugin". Create a file `.file-extensions` in the root directory of your project and list all file extensions that your DataPlugin should support. If no list is defined, you will be prompted to provide a list of file extensions on first export of your DataPlugin.
 
 # Settings
 

assets/.file-extensions

@@ -86,7 +86,7 @@
     "lint": "tslint -p ./",
     "pretest": "npm run compile && npm run lint",
     "test": "node ./out/test/runTest.js",
-    "test:e2e": "extest setup-and-run out/test/e2e/*.js -u -o ./src/test/e2e/settings.json",
+    "test:e2e": "extest setup-and-run out/test/e2e/*.js -e ./src/test/e2e -u -o ./src/test/e2e/settings.json",
     "vscode:prepublish": "npm run compile",
     "watch": "tsc -watch -p ./"
   },

package.json

@@ -9,10 +9,7 @@ import { Languages } from './plugin-languages.enum';
 
 export async function createDataPlugin(): Promise<DataPlugin | null> {
    const examples: string[] = vscu.loadExamples();
-   const examplesNames: string[] = new Array();
-   for (let i = 0; i < examples.length; i++) {
-      examplesNames[i] = path.basename(examples[i]);
-   }
+   const examplesNames: string[] = examples.map((example) => { return path.basename(example); });
 
    const scriptName: string | undefined = await vscu.showInputBox('DataPlugin name: ', 'Please enter your DataPlugin name');
    if (!scriptName) {
@@ -55,22 +52,39 @@ export async function createDataPlugin(): Promise<DataPlugin | null> {
 }
 
 export async function exportPluginFromContextMenu(uri: vscode.Uri) {
-   const extensions = await vscu.showInputBox('Please enter the file extensions your DataPlugin can handle in the right syntax: ', '*.tdm; *.xls ...');
    const scriptPath: string = uri.fsPath;
    const pluginName: string = path.basename(path.dirname(scriptPath));
 
-   let exportPath: string = config.exportPath || '';
-   if (extensions) {
-      if (!exportPath) {
-         const options: vscode.SaveDialogOptions = {
-            defaultUri: vscode.Uri.parse(`${config.dataPluginFolder}\\${pluginName}`),
-            filters: { 'Uri': ['uri'] },
-         };
-
-         const fileInfos = await vscode.window.showSaveDialog({ ...options });
-         exportPath = fileInfos?.fsPath || '';
+   let extensions: string | undefined;
+
+   try {
+      extensions = await fileutils.readFileExtensionConfig(path.dirname(scriptPath));
+   } catch (e) {
+      extensions = undefined;
+   }
+
+   if (!extensions) {
+      extensions = await vscu.showInputBox('Please enter the file extensions your DataPlugin can handle in the right syntax: ', '*.tdm; *.xls ...');
+
+      if (!extensions) {
+         return;
       }
 
-      await vscu.exportDataPlugin(scriptPath, extensions.toString(), `${exportPath}\\${pluginName}.uri`);
+      // Store selected extensions so we don't have to ask again
+      fileutils.storeFileExtensionConfig(path.dirname(scriptPath), extensions);
    }
+
+   let exportPath: string = config.exportPath || '';
+   if (!exportPath) {
+      const options: vscode.SaveDialogOptions = {
+         defaultUri: vscode.Uri.file(`${config.dataPluginFolder}\\${pluginName}\\${pluginName}.uri`),
+         filters: { 'Uri': ['uri'] },
+      };
+
+      const fileInfos = await vscode.window.showSaveDialog({ ...options });
+      exportPath = fileInfos?.fsPath || '';
+   }
+
+   await vscu.exportDataPlugin(scriptPath, extensions.toString(), `${exportPath}`);
+
 }

src/commands.ts

@@ -3,7 +3,6 @@ import * as fs from 'fs-extra';
 import * as path from 'path';
 import * as config from './config';
 import { FileExistsError } from './dataplugin-error';
-import { FileExtensions } from './file-extensions.enum';
 import { Languages } from './plugin-languages.enum';
 
 const dataPluginFolder = config.dataPluginFolder;
@@ -15,7 +14,6 @@ export class DataPlugin {
    private _scriptPath: string;
    private _language: Languages;
    private _baseTemplate: string;
-   private _fileExtensions: FileExtensions[] = new Array();
 
    get name(): string {
       return this._name;
@@ -53,14 +51,6 @@ export class DataPlugin {
       return this._baseTemplate;
    }
 
-   get fileExtensions(): FileExtensions[] {
-      return this._fileExtensions;
-   }
-
-   set fileExtensions(fileExtensionss: FileExtensions[]) {
-      this._fileExtensions = fileExtensionss;
-   }
-
    constructor(name: string, baseTemplate: string, language: Languages) {
       this._name = name;
       this._baseTemplate = baseTemplate;
@@ -77,12 +67,14 @@ export class DataPlugin {
 
    public async createMainPy(): Promise<void> {
       try {
+         const extensionsFile = '.file-extensions';
          const launchFile = 'launch.json';
          const loadFile = 'diadem_load.py';
          const assetFolder: string = path.join(dirNamePath, 'assets');
          const exampleFolder: string = path.join(dirNamePath, 'examples', this.baseTemplate);
 
          await fs.copy(exampleFolder, this.folderPath);
+         await fs.copy(path.join(assetFolder, extensionsFile), path.join(this.folderPath, extensionsFile));
          await fs.copy(path.join(assetFolder, loadFile), path.join(this.folderPath, '.ni', loadFile));
          await fs.copy(path.join(assetFolder, launchFile), path.join(this.folderPath, '.vscode', launchFile));
 

src/dataplugin.ts

@@ -1,13 +1,47 @@
-import * as path from 'path';
 import * as fs from 'fs-extra';
+import * as path from 'path';
+import * as readline from 'readline';
 import { UriTemplate } from './uri-template';
 
+async function readFirstLineOfFile(filePath: string): Promise<string> {
+   const rl = readline.createInterface({
+      input: fs.createReadStream(filePath)
+   });
+
+   return new Promise((resolve) => {
+      rl.on('line', (line) => {
+         resolve(line);
+      });
+
+      rl.on('close', () => {
+         resolve('');
+      });
+   });
+}
+
 export function createFolderSync(folder: string) {
    if (!fs.existsSync(folder)) {
       fs.mkdirSync(folder);
    }
 }
 
+export async function readFileExtensionConfig(workspaceDir: string): Promise<string> {
+   const filePath: string = path.join(workspaceDir, '.file-extensions');
+   if (fs.existsSync(filePath)) {
+      const head = await readFirstLineOfFile(filePath);
+      return Promise.resolve(head);
+   }
+
+   return Promise.reject('file not found');
+}
+
+export function storeFileExtensionConfig(workspaceDir: string, fileExtensions: string): void {
+   const filePath: string = path.join(workspaceDir, '.file-extensions');
+   if (fs.existsSync(filePath)) {
+      fs.writeFile(filePath, fileExtensions);
+   }
+}
+
 export async function writeUriFile(scriptPath: string, fileExtensions: string, exportPath: string): Promise<void> {
    const dirName = path.basename(path.dirname(scriptPath));
    const uriTemplate = new UriTemplate(`${dirName}`, scriptPath, fileExtensions);

src/file-extensions.enum.ts

@@ -1,6 +1,6 @@
 import * as assert from 'assert';
 import { Guid } from 'guid-typescript';
-import { InputBox, Workbench, TextEditor, WebDriver, VSBrowser, EditorView, SideBarView } from 'vscode-extension-tester';
+import { InputBox, Workbench, WebDriver, VSBrowser, SideBarView } from 'vscode-extension-tester';
 
 /*
    API Reference: https://github.com/redhat-developer/vscode-extension-tester/wiki/Page-Object-APIs
@@ -15,22 +15,23 @@ describe('Basic UI Tests', () => {
 
    it('Should create a new DataPlugin project', async () => {
       const randomName: string = Guid.create().toString();
+      await new Promise(res => setTimeout(res, 5000)); // wait for loading vscode completely
       const workbench = new Workbench();
       await workbench.executeCommand('NI DataPlugins: Create new Python-DataPlugin');
       await new Promise(res => setTimeout(res, 500));
 
       // Input box requesting a DataPlugin name?
       const enterDataPluginNameInputBox = await driver.wait(() => { return new InputBox(); }, 1000);
       const placeholderText1 = await enterDataPluginNameInputBox.getPlaceHolder();
-      assert.equal('Please enter your DataPlugin name', placeholderText1);
+      assert.strictEqual('Please enter your DataPlugin name', placeholderText1);
       await enterDataPluginNameInputBox.setText(randomName);
       await enterDataPluginNameInputBox.confirm();
       await new Promise(res => setTimeout(res, 500));
 
       // Input box requesting a template?
       const chooseTemplateDropDown = await driver.wait(() => { return new InputBox(); }, 1000);
       const placeholderText2 = await chooseTemplateDropDown.getPlaceHolder();
-      assert.equal('Please choose a template to start with', placeholderText2);
+      assert.strictEqual('Please choose a template to start with', placeholderText2);
       await new Promise(res => setTimeout(res, 500));
       await chooseTemplateDropDown.setText('hello-world');
       await chooseTemplateDropDown.confirm();
@@ -41,6 +42,6 @@ describe('Basic UI Tests', () => {
       const sideBarContent = await sideBarView.getContent().wait();
       const section = await sideBarContent.getSection('Untitled (Workspace)');
       const item = await section.findItem(randomName);
-      assert.notEqual(undefined, item);
+      assert.notStrictEqual(undefined, item);
    }).timeout(40000);
 });

src/file-utils.ts

@@ -0,0 +1,90 @@
+import * as assert from 'assert';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import { ActivityBar, EditorView, InputBox, SideBarView, Workbench, WebDriver, VSBrowser } from 'vscode-extension-tester';
+
+/*
+   API Reference: https://github.com/redhat-developer/vscode-extension-tester/wiki/Page-Object-APIs
+*/
+
+describe('Basic UI Tests', () => {
+   let browser: VSBrowser;
+   let driver: WebDriver;
+
+   before(() => {
+      browser = VSBrowser.instance;
+      driver = VSBrowser.instance.driver;
+   });
+
+   it('Should export a DataPlugin from a sample workspace', async () => {
+      await new Promise(res => setTimeout(res, 5000)); // wait for loading vscode completely
+
+      // Prepare Workspace
+      const workspaceDir: string = path.join(__dirname, 'sample_workspace_1');
+      // tslint:disable-next-line
+      fs.existsSync(workspaceDir) && fs.rmdirSync(workspaceDir, { recursive: true });
+      fs.mkdirSync(workspaceDir);
+      fs.writeFileSync(path.join(workspaceDir, 'dataplugin.py'), 'class Plugin:');
+
+      // init
+      const workbench = new Workbench();
+
+      // Open Workspace
+      await workbench.executeCommand('Extest: Open Folder');
+      await new Promise(res => setTimeout(res, 500));
+
+      // Enter Workspace path
+      const enterFolderName = await driver.wait(() => { return new InputBox(); }, 1000);
+      await enterFolderName.setText(workspaceDir);
+      await enterFolderName.confirm();
+      await new Promise(res => setTimeout(res, 2000));
+
+      // Open Explorer side bar
+      const sideBarView = new SideBarView();
+      const explorer = await new ActivityBar().getViewControl('Explorer');
+      await explorer.openView();
+
+      // Find python file
+      const content = await sideBarView.getContent();
+      const section = await content.getSection('Untitled (Workspace)');
+      await section.openItem('sample_workspace_1');
+      const item = await section.findItem('dataplugin.py');
+      assert.notStrictEqual(undefined, item);
+      await new Promise(res => setTimeout(res, 2000));
+
+      // Ensure the remaining workflow is not disrupted by popping editor tabs from other extensions
+      const editorView = new EditorView();
+      await editorView.closeAllEditors();
+      await new Promise(res => setTimeout(res, 2000));
+
+      // Delete file extensions settings
+      const fileExtension = path.join(workspaceDir, '.file-extensions');
+      // tslint:disable-next-line
+      fs.existsSync(fileExtension) && fs.unlinkSync(fileExtension);
+
+      // Open ContextMenu and click Export
+      const menu = await item?.openContextMenu();
+      const menuItem = await menu?.getItem('NI DataPlugins: Export DataPlugin');
+      assert.notStrictEqual(undefined, menuItem);
+      await menuItem?.select();
+
+      // Choose File Extension
+      const fileExtensionInputBox = await driver.wait(() => { return new InputBox(); }, 1000);
+      const placeholderText = await fileExtensionInputBox.getPlaceHolder();
+      assert.strictEqual('*.tdm; *.xls ...', placeholderText);
+      await fileExtensionInputBox.setText('*.csv');
+      await fileExtensionInputBox.cancel();
+
+      // Write .file-extensions file
+      fs.writeFileSync(fileExtension, '*.csv');
+
+      // Click Export again, this time no file extension prompt should show up
+      const menu2 = await item?.openContextMenu();
+      const menuItem2 = await menu2?.getItem('NI DataPlugins: Export DataPlugin');
+      await menuItem2?.select();
+      const checkForInputBoxAgain = await driver.wait(() => { return new InputBox(); }, 1000);
+      const isDisplayed = await checkForInputBoxAgain.isDisplayed();
+      assert.strictEqual(false, isDisplayed);
+
+   }).timeout(40000);
+});

src/test/e2e/create-plugin.test.ts

@@ -1,4 +1,5 @@
 {
    "typescript.updateImportsOnFileMove.enabled": "always",
-   "workbench.editor.enablePreview": true
+   "workbench.editor.enablePreview": true,
+   "update.mode": "none"
 }

src/test/e2e/export-plugin.test.ts

@@ -57,7 +57,7 @@ suite('DataPlugin Test Suite', () => {
          // tslint:disable-next-line: no-unused-expression
          new DataPlugin(randomName, 'hello-world', Languages.Python);
       } catch (e) {
-         assert.equal(e.errorType, ErrorType.FILEEXISTS);
+         assert.strictEqual(e.errorType, ErrorType.FILEEXISTS);
       }
    });
 });

src/test/e2e/settings.json

@@ -0,0 +1,27 @@
+import * as assert from 'assert';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import * as vscode from 'vscode';
+import * as fileutils from '../../file-utils';
+
+suite('File-Utils Test Suite', () => {
+   vscode.window.showInformationMessage('Start File-Utils tests.');
+
+   test('should return correct values when reading file extension config', async () => {
+      let fileExtensions: string;
+      const filePath: string = path.join(__dirname, '.file-extensions');
+
+      // tslint:disable-next-line
+      fs.existsSync(filePath) && fs.unlinkSync(filePath);
+
+      await assert.rejects(fileutils.readFileExtensionConfig(__dirname), /file not found/);
+
+      await fs.writeFile(filePath, '*.csv,*.txt');
+      fileExtensions = await fileutils.readFileExtensionConfig(__dirname);
+      assert.ok(fileExtensions === '*.csv,*.txt');
+
+      await fs.writeFile(filePath, '');
+      fileExtensions = await fileutils.readFileExtensionConfig(__dirname);
+      assert.ok(fileExtensions === '');
+   }).timeout(10000);
+});

src/test/suite/dataplugin.test.ts

@@ -12,7 +12,7 @@ export class UriTemplate {
          `<easypluginparam><![CDATA[<dllpath>@USIBINDIR@\\PythonMarshaller\\uspPythonMarshaller.dll</dllpath><script>${pythonScriptPath}</script>]]></easypluginparam>` +
          '<querysupported>0</querysupported>' +
          '<fastloadsupported>0</fastloadsupported>' +
-         `<filefilters extension="${fileExtensions}"><description>${fileName} Dateien (${fileExtensions})</description></filefilters>` +
+         `<filefilters extension="${fileExtensions}"><description>${fileName} Files (${fileExtensions})</description></filefilters>` +
          '<platform>x64</platform></storetype></usireginfo>';
    }