@cloud-cli/vm 1.0.3 → 1.2.0

package/dist/index.d.ts

@@ -1,14 +1,21 @@
 interface NameOption {
     name: string;
 }
+interface NameAndPathOption {
+    name: string;
+    path?: string;
+}
 declare function list(): Promise<string[]>;
+declare function ls(options: NameAndPathOption): Promise<string[]>;
+declare function rm(options: NameAndPathOption): Promise<boolean>;
+declare function cat(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 +23,8 @@ declare const _default: {
     list: typeof list;
     show: typeof show;
     prune: typeof prune;
+    ls: typeof ls;
+    rm: typeof rm;
+    cat: typeof cat;
 };
 export default _default;

package/dist/index.js

@@ -1,3 +1,5 @@
+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);
@@ -9,6 +11,37 @@ async function list() {
     }
     return output.stdout.trim().split('\n');
 }
+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');
+    }
+    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 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 = await getVolumeMountpoint(name);
+    return await readFile(join(root, path), 'utf8');
+}
 async function show(options) {
     if (!isValidName(options.name)) {
         throw invalidNameError;
@@ -31,7 +64,7 @@ async function add(options) {
     }
     const output = await exec('docker', ['volume', 'create', options.name]);
     if (output.ok) {
-        return '';
+        return true;
     }
     throw new Error('Unable to create volume');
 }
@@ -41,7 +74,7 @@ async function remove(options) {
     }
     const output = await exec('docker', ['volume', 'rm', options.name]);
     if (output.ok) {
-        return '';
+        return true;
     }
     throw new Error('Unable to remove volume');
 }
@@ -49,4 +82,4 @@ async function prune() {
     await exec('docker', ['volume', 'prune']);
     return '';
 }
-export default { add, remove, list, show, prune };
+export default { add, remove, list, show, prune, ls, rm, cat };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloud-cli/vm",
-  "version": "1.0.3",
+  "version": "1.2.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,71 @@ 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('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 };
@@ -61,7 +130,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 +149,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 +168,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,3 +1,5 @@
+import { join } from 'node:path';
+import { readFile } from 'node:fs/promises';
 import { exec } from '@cloud-cli/exec';
 
 const nameRe = /^[a-z][a-z0-9-]+$/;
@@ -8,6 +10,11 @@ interface NameOption {
   name: string;
 }
 
+interface NameAndPathOption {
+  name: string;
+  path?: string;
+}
+
 async function list() {
   const output = await exec('docker', ['volume', 'ls', '--format={{.Name}}']);
 
@@ -18,6 +25,49 @@ async function list() {
   return output.stdout.trim().split('\n');
 }
 
+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');
+  }
+
+  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 rm(options: NameAndPathOption) {
+  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: NameAndPathOption) {
+  const { name, path } = options;
+
+  if (!path) {
+    throw new Error('Path not specified');
+  }
+
+  const root = await getVolumeMountpoint(name);
+  return await readFile(join(root, path), 'utf8');
+}
+
 async function show(options: NameOption) {
   if (!isValidName(options.name)) {
     throw invalidNameError;
@@ -47,7 +97,7 @@ async function add(options: NameOption) {
   const output = await exec('docker', ['volume', 'create', options.name]);
 
   if (output.ok) {
-    return '';
+    return true;
   }
 
   throw new Error('Unable to create volume');
@@ -61,7 +111,7 @@ async function remove(options: NameOption) {
   const output = await exec('docker', ['volume', 'rm', options.name]);
 
   if (output.ok) {
-    return '';
+    return true;
   }
 
   throw new Error('Unable to remove volume');
@@ -72,4 +122,4 @@ async function prune() {
   return '';
 }
 
-export default { add, remove, list, show, prune };
+export default { add, remove, list, show, prune, ls, rm, cat };