@cloud-cli/vm 1.1.0 → 1.3.0

package/dist/index.d.ts

@@ -7,6 +7,9 @@ interface NameAndPathOption {
 }
 declare function list(): Promise<string[]>;
 declare function ls(options: NameAndPathOption): Promise<string[]>;
+declare function fixPermissions(options: NameOption): Promise<boolean>;
+declare function rm(options: NameAndPathOption): Promise<boolean>;
+declare function cat(options: NameAndPathOption): Promise<string>;
 declare function show(options: NameOption): Promise<{
     name: any;
     createdAt: any;
@@ -22,5 +25,8 @@ declare const _default: {
     show: typeof show;
     prune: typeof prune;
     ls: typeof ls;
+    rm: typeof rm;
+    cat: typeof cat;
+    fixPermissions: typeof fixPermissions;
 };
 export default _default;

package/dist/index.js

@@ -1,34 +1,61 @@
-import { join } from "node:path";
-import { exec } from "@cloud-cli/exec";
+import { join } from 'node:path';
+import { readFile } from 'node:fs/promises';
+import { exec } from '@cloud-cli/exec';
 const nameRe = /^[a-z][a-z0-9-]+$/;
 const isValidName = (name) => nameRe.test(name);
-const invalidNameError = new Error("Invalid name");
+const invalidNameError = new Error('Invalid name');
 async function list() {
-    const output = await exec("docker", ["volume", "ls", "--format={{.Name}}"]);
+    const output = await exec('docker', ['volume', 'ls', '--format={{.Name}}']);
     if (!output.ok) {
-        throw new Error("Unable to list volumes");
+        throw new Error('Unable to list volumes');
     }
-    return output.stdout.trim().split("\n");
+    return output.stdout.trim().split('\n');
 }
-async function ls(options) {
-    const { name, path = "" } = options;
-    const output = await exec("docker", ["volume", "inspect", name]);
+async function getVolumeMountpoint(name) {
+    const output = await exec('docker', ['volume', 'inspect', name]);
     const volumes = JSON.parse(output.stdout);
     if (!volumes.length) {
-        throw new Error("Volume not found");
+        throw new Error('Volume not found');
+    }
+    return volumes[0].Mountpoint;
+}
+async function ls(options) {
+    const { name, path = '' } = options;
+    const root = await getVolumeMountpoint(name);
+    const files = await exec('ls', ['-1', join(root, path)]);
+    return files.stdout.trim().split('\n');
+}
+async function fixPermissions(options) {
+    const { name } = options;
+    const root = await getVolumeMountpoint(name);
+    const result = await exec('chmod', ['-R', 'a+w', root]);
+    return result.ok;
+}
+async function rm(options) {
+    const { name, path } = options;
+    if (!path) {
+        throw new Error('Path not specified');
+    }
+    const root = await getVolumeMountpoint(name);
+    const result = await exec('rm', ['-r', join(root, path)]);
+    return result.ok;
+}
+async function cat(options) {
+    const { name, path } = options;
+    if (!path) {
+        throw new Error('Path not specified');
     }
-    const root = volumes[0].Mountpoint;
-    const files = await exec("ls", ["-1", join(root, path)]);
-    return files.stdout.trim().split("\n");
+    const root = await getVolumeMountpoint(name);
+    return await readFile(join(root, path), 'utf8');
 }
 async function show(options) {
     if (!isValidName(options.name)) {
         throw invalidNameError;
     }
-    const output = await exec("docker", ["volume", "inspect", options.name]);
+    const output = await exec('docker', ['volume', 'inspect', options.name]);
     const list = JSON.parse(output.stdout);
     if (!list.length) {
-        throw new Error("Volume not found");
+        throw new Error('Volume not found');
     }
     const { Name, Labels, CreatedAt } = list[0];
     return {
@@ -41,24 +68,24 @@ async function add(options) {
     if (!isValidName(options.name)) {
         throw invalidNameError;
     }
-    const output = await exec("docker", ["volume", "create", options.name]);
+    const output = await exec('docker', ['volume', 'create', options.name]);
     if (output.ok) {
         return true;
     }
-    throw new Error("Unable to create volume");
+    throw new Error('Unable to create volume');
 }
 async function remove(options) {
     if (!isValidName(options.name)) {
         throw invalidNameError;
     }
-    const output = await exec("docker", ["volume", "rm", options.name]);
+    const output = await exec('docker', ['volume', 'rm', options.name]);
     if (output.ok) {
         return true;
     }
-    throw new Error("Unable to remove volume");
+    throw new Error('Unable to remove volume');
 }
 async function prune() {
-    await exec("docker", ["volume", "prune"]);
-    return "";
+    await exec('docker', ['volume', 'prune']);
+    return '';
 }
-export default { add, remove, list, show, prune, ls };
+export default { add, remove, list, show, prune, ls, rm, cat, fixPermissions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloud-cli/vm",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Docker volume management",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.spec.ts

@@ -2,12 +2,16 @@ const execMocks = {
   exec: jest.fn(),
 };
 
-jest.mock('@cloud-cli/exec', () => {
-  return execMocks;
-});
+const fsMocks = {
+  readFile: jest.fn(),
+};
+
+jest.mock('@cloud-cli/exec', () => execMocks);
+jest.mock('node:fs/promises', () => fsMocks);
 
 import vm from './index';
 import * as exec from '@cloud-cli/exec';
+import * as fs from 'node:fs/promises';
 
 const inspectOutput = `[{
 "CreatedAt": "2023-03-10T10:15:10Z",
@@ -44,6 +48,17 @@ describe('volume manager', () => {
     });
   });
 
+  describe('fixPermissions', () => {
+    it('should fix write permissions on volume folder', async () => {
+      const outputs = [inspectOutput, ''];
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: outputs.shift() }));
+
+      await expect(vm.fixPermissions({ name: 'test' })).resolves.toEqual(true);
+      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(exec.exec).toHaveBeenCalledWith('chmod', ['-R', 'a+w', '/var/lib/docker/volumes/test/_data']);
+    });
+  });
+
   describe('ls', () => {
     it('should list files of a volume and path', async () => {
       const outputs = [inspectOutput, 'dir', inspectOutput, 'a.txt\nb.txt'];
@@ -63,6 +78,52 @@ describe('volume manager', () => {
     });
   });
 
+  describe('rm', () => {
+    it('should remove files of a volume by path', async () => {
+      const outputs = [inspectOutput, ''];
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: outputs.shift() }));
+
+      await expect(vm.rm({ name: 'test', path: 'file.txt' })).resolves.toEqual(true);
+
+      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(exec.exec).toHaveBeenCalledWith('rm', ['-r', '/var/lib/docker/volumes/test/_data/file.txt']);
+    });
+
+    it('should throw an error if volume name is invalid', async () => {
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: '[]' }));
+      await expect(vm.rm({ name: 'notfound', path: 'file.txt' })).rejects.toThrowError('Volume not found');
+    });
+
+    it('should throw an error if path is invalid', async () => {
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: inspectOutput }));
+      await expect(vm.rm({ name: 'nopath' })).rejects.toThrowError('Path not specified');
+      expect(execMocks.exec).not.toHaveBeenCalled();
+    });
+  });
+
+  describe('cat', () => {
+    it('should read the content of a file in a volume by path', async () => {
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: inspectOutput }));
+      fsMocks.readFile = jest.fn().mockImplementation(() => 'test file');
+
+      await expect(vm.cat({ name: 'test', path: 'file.txt' })).resolves.toEqual('test file');
+
+      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(fs.readFile).toHaveBeenCalledWith('/var/lib/docker/volumes/test/_data/file.txt', 'utf8');
+    });
+
+    it('should throw an error if volume name is invalid', async () => {
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: '[]' }));
+      await expect(vm.cat({ name: 'notfound', path: 'file.txt' })).rejects.toThrowError('Volume not found');
+    });
+
+    it('should throw an error if path is invalid', async () => {
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: inspectOutput }));
+      await expect(vm.cat({ name: 'nopath' })).rejects.toThrowError('Path not specified');
+      expect(execMocks.exec).not.toHaveBeenCalled();
+    });
+  });
+
   describe('show', () => {
     it('should show details of a volume', async () => {
       const execOutput = { ok: true, stdout: inspectOutput };

package/src/index.ts

@@ -1,9 +1,10 @@
-import { join } from "node:path";
-import { exec } from "@cloud-cli/exec";
+import { join } from 'node:path';
+import { readFile } from 'node:fs/promises';
+import { exec } from '@cloud-cli/exec';
 
 const nameRe = /^[a-z][a-z0-9-]+$/;
 const isValidName = (name) => nameRe.test(name);
-const invalidNameError = new Error("Invalid name");
+const invalidNameError = new Error('Invalid name');
 
 interface NameOption {
   name: string;
@@ -15,28 +16,64 @@ interface NameAndPathOption {
 }
 
 async function list() {
-  const output = await exec("docker", ["volume", "ls", "--format={{.Name}}"]);
+  const output = await exec('docker', ['volume', 'ls', '--format={{.Name}}']);
 
   if (!output.ok) {
-    throw new Error("Unable to list volumes");
+    throw new Error('Unable to list volumes');
   }
 
-  return output.stdout.trim().split("\n");
+  return output.stdout.trim().split('\n');
 }
 
-async function ls(options: NameAndPathOption) {
-  const { name, path = "" } = options;
-  const output = await exec("docker", ["volume", "inspect", name]);
+async function getVolumeMountpoint(name): Promise<string> {
+  const output = await exec('docker', ['volume', 'inspect', name]);
   const volumes = JSON.parse(output.stdout);
 
   if (!volumes.length) {
-    throw new Error("Volume not found");
+    throw new Error('Volume not found');
+  }
+
+  return volumes[0].Mountpoint;
+}
+
+async function ls(options: NameAndPathOption) {
+  const { name, path = '' } = options;
+  const root = await getVolumeMountpoint(name);
+  const files = await exec('ls', ['-1', join(root, path)]);
+
+  return files.stdout.trim().split('\n');
+}
+
+async function fixPermissions(options: NameOption) {
+  const { name } = options;
+  const root = await getVolumeMountpoint(name);
+  const result = await exec('chmod', ['-R', 'a+w', root]);
+
+  return result.ok;
+}
+
+async function rm(options: NameAndPathOption) {
+  const { name, path } = options;
+
+  if (!path) {
+    throw new Error('Path not specified');
   }
 
-  const root = volumes[0].Mountpoint;
-  const files = await exec("ls", ["-1", join(root, path)]);
+  const root = await getVolumeMountpoint(name);
+  const result = await exec('rm', ['-r', join(root, path)]);
+
+  return result.ok;
+}
+
+async function cat(options: NameAndPathOption) {
+  const { name, path } = options;
+
+  if (!path) {
+    throw new Error('Path not specified');
+  }
 
-  return files.stdout.trim().split("\n");
+  const root = await getVolumeMountpoint(name);
+  return await readFile(join(root, path), 'utf8');
 }
 
 async function show(options: NameOption) {
@@ -44,11 +81,11 @@ async function show(options: NameOption) {
     throw invalidNameError;
   }
 
-  const output = await exec("docker", ["volume", "inspect", options.name]);
+  const output = await exec('docker', ['volume', 'inspect', options.name]);
   const list = JSON.parse(output.stdout);
 
   if (!list.length) {
-    throw new Error("Volume not found");
+    throw new Error('Volume not found');
   }
 
   const { Name, Labels, CreatedAt } = list[0];
@@ -65,13 +102,13 @@ async function add(options: NameOption) {
     throw invalidNameError;
   }
 
-  const output = await exec("docker", ["volume", "create", options.name]);
+  const output = await exec('docker', ['volume', 'create', options.name]);
 
   if (output.ok) {
     return true;
   }
 
-  throw new Error("Unable to create volume");
+  throw new Error('Unable to create volume');
 }
 
 async function remove(options: NameOption) {
@@ -79,18 +116,18 @@ async function remove(options: NameOption) {
     throw invalidNameError;
   }
 
-  const output = await exec("docker", ["volume", "rm", options.name]);
+  const output = await exec('docker', ['volume', 'rm', options.name]);
 
   if (output.ok) {
     return true;
   }
 
-  throw new Error("Unable to remove volume");
+  throw new Error('Unable to remove volume');
 }
 
 async function prune() {
-  await exec("docker", ["volume", "prune"]);
-  return "";
+  await exec('docker', ['volume', 'prune']);
+  return '';
 }
 
-export default { add, remove, list, show, prune, ls };
+export default { add, remove, list, show, prune, ls, rm, cat, fixPermissions };