@cloud-cli/vm 1.0.3 → 1.1.0

package/dist/index.d.ts

@@ -1,14 +1,19 @@
 interface NameOption {
     name: string;
 }
+interface NameAndPathOption {
+    name: string;
+    path?: string;
+}
 declare function list(): Promise<string[]>;
+declare function ls(options: NameAndPathOption): Promise<string[]>;
 declare function show(options: NameOption): Promise<{
     name: any;
     createdAt: any;
     labels: any;
 }>;
-declare function add(options: NameOption): Promise<string>;
-declare function remove(options: NameOption): Promise<string>;
+declare function add(options: NameOption): Promise<boolean>;
+declare function remove(options: NameOption): Promise<boolean>;
 declare function prune(): Promise<string>;
 declare const _default: {
     add: typeof add;
@@ -16,5 +21,6 @@ declare const _default: {
     list: typeof list;
     show: typeof show;
     prune: typeof prune;
+    ls: typeof ls;
 };
 export default _default;

package/dist/index.js

@@ -1,22 +1,34 @@
-import { exec } from '@cloud-cli/exec';
+import { join } from "node:path";
+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]);
+    const volumes = JSON.parse(output.stdout);
+    if (!volumes.length) {
+        throw new Error("Volume not found");
+    }
+    const root = volumes[0].Mountpoint;
+    const files = await exec("ls", ["-1", join(root, path)]);
+    return files.stdout.trim().split("\n");
 }
 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 {
@@ -29,24 +41,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 '';
+        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 '';
+        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 };
+export default { add, remove, list, show, prune, ls };

package/package.json

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

package/src/index.spec.ts

@@ -44,6 +44,25 @@ describe('volume manager', () => {
     });
   });
 
+  describe('ls', () => {
+    it('should list files of a volume and path', async () => {
+      const outputs = [inspectOutput, 'dir', inspectOutput, 'a.txt\nb.txt'];
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: outputs.shift() }));
+
+      await expect(vm.ls({ name: 'test' })).resolves.toEqual(['dir']);
+      await expect(vm.ls({ name: 'test', path: 'dir' })).resolves.toEqual(['a.txt', 'b.txt']);
+
+      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(exec.exec).toHaveBeenCalledWith('ls', ['-1', '/var/lib/docker/volumes/test/_data']);
+      expect(exec.exec).toHaveBeenCalledWith('ls', ['-1', '/var/lib/docker/volumes/test/_data/dir']);
+    });
+
+    it('should throw an error if volume name is invalid', async () => {
+      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: '[]' }));
+      await expect(vm.ls({ name: 'notfound' })).rejects.toThrowError('Volume not found');
+    });
+  });
+
   describe('show', () => {
     it('should show details of a volume', async () => {
       const execOutput = { ok: true, stdout: inspectOutput };
@@ -61,7 +80,7 @@ describe('volume manager', () => {
       expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
     });
 
-    it('should throw error if volume name is invalid', async () => {
+    it('should throw an error if volume name is invalid', async () => {
       execMocks.exec = jest.fn();
       await expect(vm.show({ name: 'In$%valid' })).rejects.toThrowError('Invalid name');
       expect(exec.exec).not.toHaveBeenCalled();
@@ -80,7 +99,7 @@ describe('volume manager', () => {
       const execOutput = { ok: true, stdout: 'test' };
       execMocks.exec = jest.fn().mockResolvedValue(execOutput);
 
-      await expect(vm.add({ name: 'test' })).resolves.toEqual('');
+      await expect(vm.add({ name: 'test' })).resolves.toEqual(true);
 
       expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'create', 'test']);
     });
@@ -99,12 +118,12 @@ describe('volume manager', () => {
     });
   });
 
-  describe('delete', () => {
+  describe('remove', () => {
     it('should add a volume', async () => {
       const execOutput = { ok: true, stdout: '' };
       execMocks.exec = jest.fn().mockResolvedValue(execOutput);
 
-      await expect(vm.remove({ name: 'test' })).resolves.toEqual('');
+      await expect(vm.remove({ name: 'test' })).resolves.toEqual(true);
 
       expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'rm', 'test']);
     });

package/src/index.ts

@@ -1,21 +1,42 @@
-import { exec } from '@cloud-cli/exec';
+import { join } from "node:path";
+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;
 }
 
+interface NameAndPathOption {
+  name: string;
+  path?: string;
+}
+
 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]);
+  const volumes = JSON.parse(output.stdout);
+
+  if (!volumes.length) {
+    throw new Error("Volume not found");
+  }
+
+  const root = volumes[0].Mountpoint;
+  const files = await exec("ls", ["-1", join(root, path)]);
+
+  return files.stdout.trim().split("\n");
 }
 
 async function show(options: NameOption) {
@@ -23,11 +44,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];
@@ -44,13 +65,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 '';
+    return true;
   }
 
-  throw new Error('Unable to create volume');
+  throw new Error("Unable to create volume");
 }
 
 async function remove(options: NameOption) {
@@ -58,18 +79,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 '';
+    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 };
+export default { add, remove, list, show, prune, ls };