@cloud-cli/vm 1.3.0 → 1.3.2

package/.github/workflows/cicd.yml

@@ -1,13 +1,10 @@
 name: CICD
 on:
-  push:
-    branches:
-      - main
+  - push
+
 jobs:
   release:
-    uses: homebots/workflows/.github/workflows/node-build-release.yml@master
-    with:
-      branches: main
+    uses: cloud-cli/workflows/.github/workflows/npm-build-release.yml@main
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/dist/index.js

@@ -23,7 +23,7 @@ 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');
+    return files.stdout.trim().split('\n').filter(Boolean);
 }
 async function fixPermissions(options) {
     const { name } = options;

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@cloud-cli/vm",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Docker volume management",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "type": "module",
   "prettier": "@cloud-cli/prettier-config",
   "scripts": {
-    "test": "jest",
-    "tdd": "jest --watchAll",
+    "test": "vitest",
     "build": "tsc"
   },
   "keywords": [
@@ -24,11 +23,15 @@
   "author": "Darlan Alves <me@darlanalv.es>",
   "license": "MIT",
   "devDependencies": {
-    "@cloud-cli/jest-config": "^1.0.0",
     "@cloud-cli/prettier-config": "^1.0.0",
-    "@cloud-cli/typescript-config": "^1.0.1"
+    "@cloud-cli/typescript-config": "^1.0.1",
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0"
   },
   "dependencies": {
     "@cloud-cli/exec": "^1.0.1"
+  },
+  "peerDependencies": {
+    "@cloud-cli/cli": "^2.0.0"
   }
 }

package/src/index.spec.ts

@@ -1,17 +1,17 @@
-const execMocks = {
-  exec: jest.fn(),
-};
+import { describe, expect, it, vi, beforeEach } from 'vitest';
 
-const fsMocks = {
-  readFile: jest.fn(),
-};
+const execMocks = vi.hoisted(() => ({
+  exec: vi.fn(),
+  readFile: vi.fn(),
+}));
 
-jest.mock('@cloud-cli/exec', () => execMocks);
-jest.mock('node:fs/promises', () => fsMocks);
+vi.mock('get-port', () => ({ default: vi.fn().mockReturnValue(1234) }));
+vi.mock('@cloud-cli/exec', () => ({ exec: execMocks.exec }));
+
+vi.mock('@cloud-cli/exec', () => ({ exec: execMocks.exec }));
+vi.mock('node:fs/promises', () => ({ readFile: execMocks.readFile }));
 
 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",
@@ -27,6 +27,11 @@ const inspectOutput = `[{
 }]`;
 
 describe('volume manager', () => {
+  beforeEach(() => {
+    execMocks.exec.mockReset();
+    execMocks.readFile.mockReset();
+  });
+
   describe('list', () => {
     it('should list the available volumes', async () => {
       const execOutput = {
@@ -34,15 +39,15 @@ describe('volume manager', () => {
         stdout: `test\ntest2\n`,
       };
 
-      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+      execMocks.exec.mockResolvedValue(execOutput);
 
       await expect(vm.list()).resolves.toEqual(['test', 'test2']);
-      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'ls', '--format={{.Name}}']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'ls', '--format={{.Name}}']);
     });
 
     it('should reject in case of error', async () => {
       const output = { ok: false };
-      execMocks.exec = jest.fn().mockResolvedValue(output);
+      execMocks.exec.mockResolvedValue(output);
 
       await expect(vm.list()).rejects.toThrowError('Unable to list volumes');
     });
@@ -51,29 +56,29 @@ 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() }));
+      execMocks.exec.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']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(execMocks.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'];
-      execMocks.exec = jest.fn().mockImplementation(() => ({ ok: true, stdout: outputs.shift() }));
+      execMocks.exec.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']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(execMocks.exec).toHaveBeenCalledWith('ls', ['-1', '/var/lib/docker/volumes/test/_data']);
+      expect(execMocks.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: '[]' }));
+      execMocks.exec.mockImplementation(() => ({ ok: true, stdout: '[]' }));
       await expect(vm.ls({ name: 'notfound' })).rejects.toThrowError('Volume not found');
     });
   });
@@ -81,21 +86,21 @@ 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() }));
+      execMocks.exec.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']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(execMocks.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: '[]' }));
+      execMocks.exec.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 }));
+      execMocks.exec.mockImplementation(() => ({ ok: true, stdout: inspectOutput }));
       await expect(vm.rm({ name: 'nopath' })).rejects.toThrowError('Path not specified');
       expect(execMocks.exec).not.toHaveBeenCalled();
     });
@@ -103,22 +108,22 @@ describe('volume manager', () => {
 
   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');
+      execMocks.exec.mockImplementation(() => ({ ok: true, stdout: inspectOutput }));
+      execMocks.readFile.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');
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(execMocks.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: '[]' }));
+      execMocks.exec.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 }));
+      execMocks.exec.mockImplementation(() => ({ ok: true, stdout: inspectOutput }));
       await expect(vm.cat({ name: 'nopath' })).rejects.toThrowError('Path not specified');
       expect(execMocks.exec).not.toHaveBeenCalled();
     });
@@ -127,7 +132,7 @@ describe('volume manager', () => {
   describe('show', () => {
     it('should show details of a volume', async () => {
       const execOutput = { ok: true, stdout: inspectOutput };
-      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+      execMocks.exec.mockResolvedValue(execOutput);
 
       await expect(vm.show({ name: 'test' })).resolves.toEqual({
         name: 'test',
@@ -138,18 +143,17 @@ describe('volume manager', () => {
         },
       });
 
-      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
     });
 
     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();
+      expect(execMocks.exec).not.toHaveBeenCalled();
     });
 
     it('should throw error if volume does not exist', async () => {
       const output = { ok: true, stdout: '[]' };
-      execMocks.exec = jest.fn().mockResolvedValue(output);
+      execMocks.exec.mockResolvedValue(output);
 
       await expect(vm.show({ name: 'invalid' })).rejects.toThrowError('Volume not found');
     });
@@ -158,22 +162,21 @@ describe('volume manager', () => {
   describe('add', () => {
     it('should add a volume', async () => {
       const execOutput = { ok: true, stdout: 'test' };
-      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+      execMocks.exec.mockResolvedValue(execOutput);
 
       await expect(vm.add({ name: 'test' })).resolves.toEqual(true);
 
-      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'create', 'test']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'create', 'test']);
     });
 
     it('should throw error if volume name is invalid', async () => {
-      execMocks.exec = jest.fn();
       await expect(vm.add({ name: 'In$%valid' })).rejects.toThrowError('Invalid name');
-      expect(exec.exec).not.toHaveBeenCalled();
+      expect(execMocks.exec).not.toHaveBeenCalled();
     });
 
     it('should throw error if volume creation fails', async () => {
       const output = { ok: false, stdout: '' };
-      execMocks.exec = jest.fn().mockResolvedValue(output);
+      execMocks.exec.mockResolvedValue(output);
 
       await expect(vm.add({ name: 'failed' })).rejects.toThrowError('Unable to create volume');
     });
@@ -182,22 +185,21 @@ describe('volume manager', () => {
   describe('remove', () => {
     it('should add a volume', async () => {
       const execOutput = { ok: true, stdout: '' };
-      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+      execMocks.exec.mockResolvedValue(execOutput);
 
       await expect(vm.remove({ name: 'test' })).resolves.toEqual(true);
 
-      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'rm', 'test']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'rm', 'test']);
     });
 
     it('should throw error if volume name is invalid', async () => {
-      execMocks.exec = jest.fn();
       await expect(vm.remove({ name: 'In$%valid' })).rejects.toThrowError('Invalid name');
-      expect(exec.exec).not.toHaveBeenCalled();
+      expect(execMocks.exec).not.toHaveBeenCalled();
     });
 
     it('should throw error if volume removal fails', async () => {
       const output = { ok: false, stdout: '' };
-      execMocks.exec = jest.fn().mockResolvedValue(output);
+      execMocks.exec.mockResolvedValue(output);
 
       await expect(vm.remove({ name: 'failed' })).rejects.toThrowError('Unable to remove volume');
     });
@@ -206,11 +208,11 @@ describe('volume manager', () => {
   describe('prune', () => {
     it('should remove ununsed volumes', async () => {
       const execOutput = { ok: true, stdout: '' };
-      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+      execMocks.exec.mockResolvedValue(execOutput);
 
       await expect(vm.prune()).resolves.toEqual('');
 
-      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'prune']);
+      expect(execMocks.exec).toHaveBeenCalledWith('docker', ['volume', 'prune']);
     });
   });
 });

package/src/index.ts

@@ -41,7 +41,7 @@ async function ls(options: NameAndPathOption) {
   const root = await getVolumeMountpoint(name);
   const files = await exec('ls', ['-1', join(root, path)]);
 
-  return files.stdout.trim().split('\n');
+  return files.stdout.trim().split('\n').filter(Boolean);
 }
 
 async function fixPermissions(options: NameOption) {