Merge pull request #3128 from SamJessep/feat/deploy_selected_files

Added the ability to deploy selected files from the explorer

Author: sebjulliand

package.json

@@ -1317,6 +1317,13 @@
 				"icon": "$(cloud-upload)",
 				"enablement": "code-for-ibmi:connected && !code-for-ibmi:isReadonly && workspaceFolderCount >= 1"
 			},
+			{
+				"command": "code-for-ibmi.deploySelected",
+				"title": "Deploy Selected Files",
+				"category": "IBM i",
+				"icon": "$(cloud-upload)",
+				"enablement": "code-for-ibmi:connected && !code-for-ibmi:isReadonly"
+			},
 			{
 				"command": "code-for-ibmi.setDeployLocation",
 				"enablement": "code-for-ibmi:connected && !code-for-ibmi:isReadonly",
@@ -3216,6 +3223,11 @@
 					"command": "code-for-ibmi.runAction",
 					"when": "code-for-ibmi:connected && !explorerResourceIsFolder && code-for-ibmi:hasLocalActions",
 					"group": "1_localactions@01"
+				},
+				{
+					"command": "code-for-ibmi.deploySelected",
+					"when": "code-for-ibmi:connected && resource",
+					"group": "1_localactions@02"
 				}
 			]
 		},

src/api/types.ts

@@ -1,6 +1,6 @@
 import { Variables } from "./variables";
 
-export type DeploymentMethod = "all" | "staged" | "unstaged" | "changed" | "compare";
+export type DeploymentMethod = "all" | "staged" | "unstaged" | "changed" | "compare" | "selected";
 
 export interface StandardIO {
   onStdout?: (data: Buffer) => void;

src/filesystems/local/deployTools.ts

@@ -81,9 +81,10 @@ export namespace DeployTools {
    * @param workspaceIndex if no index is provided, a prompt will be shown to pick one if there are multiple workspaces,
    * otherwise the current workspace will be used.
    * @param method if no method is provided, a prompt will be shown to pick the deployment method.
+   * @param selectedFiles if the "selected" deployment method is used, these files will be deployed.
    * @returns the index of the deployed workspace or `undefined` if the deployment failed
    */
-  export async function launchDeploy(workspaceIndex?: number, method?: DeploymentMethod): Promise<{ remoteDirectory: string, workspaceId: number } | undefined> {
+  export async function launchDeploy(workspaceIndex?: number, method?: DeploymentMethod, selectedFiles?: Uri[]): Promise<{ remoteDirectory: string, workspaceId: number } | undefined> {
     const folder = await Deployment.getWorkspaceFolder(workspaceIndex);
     if (folder) {
       const remotePath = getRemoteDeployDirectory(folder);
@@ -127,7 +128,8 @@ export namespace DeployTools {
           const parameters: DeploymentParameters = {
             workspaceFolder: folder,
             remotePath,
-            method
+            method,
+            selectedFiles
           };
 
           if (await deploy(parameters)) {
@@ -140,7 +142,7 @@ export namespace DeployTools {
         }
       } else {
         if (await vscode.window.showErrorMessage(`Chosen location (${folder.uri.fsPath}) is not configured for deployment.`, 'Set deploy location')) {
-          setDeployLocation(undefined, folder, buildPossibleDeploymentDirectory(folder));
+          setDeployLocation(undefined, folder, buildPossibleDeploymentDirectory(folder), method, selectedFiles);
         }
       }
     }
@@ -187,6 +189,10 @@ export namespace DeployTools {
               deletes.push(...relativeRemoteDeletes);
               break;
 
+            case "selected":
+              files.push(...parameters.selectedFiles || []);
+              break;
+
             case "all":
               files.push(...await getDeployAllFiles(parameters));
               break;
@@ -333,7 +339,7 @@ export namespace DeployTools {
     return (await Deployment.findFiles(parameters, "**/*", "**/.git*"));
   }
 
-  export async function setDeployLocation(node: any, workspaceFolder?: WorkspaceFolder, value?: string) {
+  export async function setDeployLocation(node: any, workspaceFolder?: WorkspaceFolder, value?: string, method?: DeploymentMethod, selectedFiles?: Uri[]) {
     const path = node?.path || await vscode.window.showInputBox({
       prompt: `Enter IFS directory to deploy to`,
       value
@@ -353,7 +359,7 @@ export namespace DeployTools {
         instance.fire(`deployLocation`);
 
         if (await vscode.window.showInformationMessage(`Deployment location set to ${path}`, `Deploy now`)) {
-          vscode.commands.executeCommand(`code-for-ibmi.launchDeploy`, chosenWorkspaceFolder.index);
+          vscode.commands.executeCommand(`code-for-ibmi.launchDeploy`, chosenWorkspaceFolder.index, method, selectedFiles);
         }
       }
     }

src/filesystems/local/deployment.ts

@@ -2,7 +2,7 @@
 import path from 'path';
 import { create as tarCreate, t as tarT } from 'tar';
 import tmp from 'tmp';
-import vscode from 'vscode';
+import vscode, { Uri } from 'vscode';
 import { getActions, getLocalActionsFiles } from '../../api/actions';
 import IBMi from '../../api/IBMi';
 import IBMiContent from '../../api/IBMiContent';
@@ -38,6 +38,27 @@ export namespace Deployment {
       deploymentLog,
       vscode.commands.registerCommand(`code-for-ibmi.launchActionsSetup`, DeployTools.launchActionsSetup),
       vscode.commands.registerCommand(`code-for-ibmi.launchDeploy`, DeployTools.launchDeploy),
+      vscode.commands.registerCommand(`code-for-ibmi.deploySelected`, async (item?: Uri, items?: Uri[]) => {
+        if(!(item instanceof Uri)) {
+          vscode.window.showErrorMessage(`No files selected for deployment.`);
+          return;
+        }
+        const selectedItems = Array.isArray(items) && items.length > 0 ? items : [item];
+        const itemsByWorkspace: Uri[][] = [];
+        selectedItems.forEach(uri => {
+          const workspace = vscode.workspace.getWorkspaceFolder(uri);
+          if (workspace) {
+            let uris = itemsByWorkspace[workspace.index];
+            if (!uris) uris = [];
+            uris.push(uri);
+            itemsByWorkspace[workspace.index] = uris;
+          }
+        });
+
+        await Promise.all(
+          itemsByWorkspace.map((workspaceItems, workspaceIndex) => DeployTools.launchDeploy(workspaceIndex, "selected", workspaceItems))
+        );
+      }),
       vscode.commands.registerCommand(`code-for-ibmi.setDeployLocation`, DeployTools.setDeployLocation)
     );
 

src/testing/deployTools.ts

@@ -147,6 +147,19 @@ export const DeployToolsSuite: TestSuite = {
                 assert.strictEqual(deleted, 1);
             }
         },
+        {
+            name: `Test 'Selected' deployment`, test: async () => {
+                const filesToDeploy = [
+                    fakeProject.files![1].localPath!,
+                    fakeProject.folders![0].localPath!,
+                ]
+
+                const locals = await getLocalFilesInfoForSelected(filesToDeploy);
+                const remotes = await deploy("selected", filesToDeploy);
+                assert.strictEqual(remotes.size, 4, "Expected 1 root file and 3 files from the folder to be deployed");
+                assertFilesInfoEquals(locals, remotes);
+            }
+        },
         {
             name: `postDownload test`, test: async () => {
                 const action: Action = {
@@ -215,7 +228,7 @@ export const DeployToolsSuite: TestSuite = {
     },
 }
 
-async function deploy(method: DeploymentMethod) {
+async function deploy(method: DeploymentMethod, selectedFiles?: vscode.Uri[]) {
     assert.ok(fakeProject.localPath, "No local path");
     assert.ok(fakeProject.remotePath, "No remote path");
     const workspaceFolder = vscode.workspace.getWorkspaceFolder(fakeProject.localPath);
@@ -227,7 +240,7 @@ async function deploy(method: DeploymentMethod) {
         `!${basename(fakeProject.localPath.path)}/**` //Allow content
     ]);
 
-    assert.ok(await DeployTools.deploy({ method, remotePath: fakeProject.remotePath, workspaceFolder, ignoreRules }), `"${method}" deployment failed`);
+    assert.ok(await DeployTools.deploy({ method, remotePath: fakeProject.remotePath, workspaceFolder, ignoreRules, selectedFiles }), `"${method}" deployment failed`);
     return await getRemoteFilesInfo();
 }
 
@@ -265,6 +278,17 @@ async function getLocalFilesInfo() {
     return localFiles;
 }
 
+async function getLocalFilesInfoForSelected(selectedFiles: vscode.Uri[]) {
+    const localFiles = await getLocalFilesInfo();
+    const selectedPaths = selectedFiles.map(file => posix.join(basename(fakeProject.localPath!.path), posix.relative(fakeProject.localPath!.path, file.path)));
+    for (const path of localFiles.keys()) {
+        if (!selectedPaths.some(selected => selected === path || path.startsWith(selected+'/'))) {
+            localFiles.delete(path);
+        }
+    }
+    return localFiles;
+}
+
 async function getRemoteFilesInfo() {
     const remoteFiles: FilesInfo = new Map;
 

src/typings.ts

@@ -1,5 +1,5 @@
 import { Ignore } from "ignore";
-import { WorkspaceFolder } from "vscode";
+import { Uri, WorkspaceFolder } from "vscode";
 import Instance from "./Instance";
 import { ComponentRegistry } from './api/components/manager';
 import { ConnectionManager } from "./api/configuration/config/ConnectionManager";
@@ -27,6 +27,7 @@ export interface DeploymentParameters {
   workspaceFolder: WorkspaceFolder
   remotePath: string
   ignoreRules?: Ignore
+  selectedFiles?: Uri[]
 }
 
 export * from "./api/types";