@cloud-cli/vm 1.0.0

package/.github/workflows/cicd.yml

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

package/README.md

@@ -0,0 +1,47 @@
+# Docker volume management
+
+## Usage
+
+```
+npm i @cloud-cli/vm
+```
+
+```js
+// cloudy.conf.mjs
+
+import volume from '@cloud-cli/vm';
+
+export default { volume };
+```
+
+## API
+
+**Create a volume**
+
+```
+cy volume.add --name "foo"
+```
+
+**Remove a volume**
+
+```
+cy volume.remove --name "foo"
+```
+
+**Get details of a volume**
+
+```
+cy volume.show --name "foo"
+```
+
+**List volumes**
+
+```
+cy volume.list
+```
+
+**Prune unused volumes**
+
+```
+cy volume.prune
+```

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+interface NameOption {
+    name: string;
+}
+declare function list(): 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 prune(): Promise<string>;
+declare const _default: {
+    add: typeof add;
+    list: typeof list;
+    show: typeof show;
+    delete: typeof remove;
+    prune: typeof prune;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,52 @@
+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');
+async function list() {
+    const output = await exec('docker', ['volume', 'ls', '--format="{{.Name}}"']);
+    if (!output.ok) {
+        throw new Error('Unable to list volumes');
+    }
+    return output.stdout.trim().split('\n');
+}
+async function show(options) {
+    if (!isValidName(options.name)) {
+        throw invalidNameError;
+    }
+    const output = await exec('docker', ['volume', 'inspect', options.name]);
+    const list = JSON.parse(output.stdout);
+    if (!list.length) {
+        throw new Error('Volume not found');
+    }
+    const { Name, Labels, CreatedAt } = list[0];
+    return {
+        name: Name,
+        createdAt: CreatedAt,
+        labels: Labels,
+    };
+}
+async function add(options) {
+    if (!isValidName(options.name)) {
+        throw invalidNameError;
+    }
+    const output = await exec('docker', ['volume', 'create', options.name]);
+    if (output.ok) {
+        return '';
+    }
+    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]);
+    if (output.ok) {
+        return '';
+    }
+    throw new Error('Unable to remove volume');
+}
+async function prune() {
+    await exec('docker', ['volume', 'prune']);
+    return '';
+}
+export default { add, list, show, delete: remove, prune };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@cloud-cli/vm",
+  "version": "1.0.0",
+  "description": "Docker volume management",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "prettier": "@cloud-cli/prettier-config",
+  "scripts": {
+    "test": "jest",
+    "tdd": "jest --watchAll",
+    "build": "tsc"
+  },
+  "keywords": [
+    "cloudy"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cloud-cli/vm"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "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"
+  },
+  "dependencies": {
+    "@cloud-cli/exec": "^1.0.1"
+  }
+}

package/src/index.spec.ts

@@ -0,0 +1,136 @@
+const execMocks = {
+  exec: jest.fn(),
+};
+
+jest.mock('@cloud-cli/exec', () => {
+  return execMocks;
+});
+
+import vm from './index';
+import * as exec from '@cloud-cli/exec';
+
+const inspectOutput = `[{
+"CreatedAt": "2023-03-10T10:15:10Z",
+"Driver": "local",
+"Labels": {
+  "origin": "test/container",
+  "version": "534524"
+},
+"Mountpoint": "/var/lib/docker/volumes/test/_data",
+"Name": "test",
+"Options": {},
+"Scope": "local"
+}]`;
+
+describe('volume manager', () => {
+  describe('list', () => {
+    it('should list the available volumes', async () => {
+      const execOutput = {
+        ok: true,
+        stdout: `test\ntest2\n`,
+      };
+
+      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+
+      await expect(vm.list()).resolves.toEqual(['test', 'test2']);
+      expect(exec.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);
+
+      await expect(vm.list()).rejects.toThrowError('Unable to list volumes');
+    });
+  });
+
+  describe('show', () => {
+    it('should show details of a volume', async () => {
+      const execOutput = { ok: true, stdout: inspectOutput };
+      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+
+      await expect(vm.show({ name: 'test' })).resolves.toEqual({
+        name: 'test',
+        createdAt: '2023-03-10T10:15:10Z',
+        labels: {
+          origin: 'test/container',
+          version: '534524',
+        },
+      });
+
+      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'inspect', 'test']);
+    });
+
+    it('should throw 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();
+    });
+
+    it('should throw error if volume does not exist', async () => {
+      const output = { ok: true, stdout: '[]' };
+      execMocks.exec = jest.fn().mockResolvedValue(output);
+
+      await expect(vm.show({ name: 'invalid' })).rejects.toThrowError('Volume not found');
+    });
+  });
+
+  describe('add', () => {
+    it('should add a volume', async () => {
+      const execOutput = { ok: true, stdout: 'test' };
+      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+
+      await expect(vm.add({ name: 'test' })).resolves.toEqual('');
+
+      expect(exec.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();
+    });
+
+    it('should throw error if volume creation fails', async () => {
+      const output = { ok: false, stdout: '' };
+      execMocks.exec = jest.fn().mockResolvedValue(output);
+
+      await expect(vm.add({ name: 'failed' })).rejects.toThrowError('Unable to create volume');
+    });
+  });
+
+  describe('delete', () => {
+    it('should add a volume', async () => {
+      const execOutput = { ok: true, stdout: '' };
+      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+
+      await expect(vm.delete({ name: 'test' })).resolves.toEqual('');
+
+      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'rm', 'test']);
+    });
+
+    it('should throw error if volume name is invalid', async () => {
+      execMocks.exec = jest.fn();
+      await expect(vm.delete({ name: 'In$%valid' })).rejects.toThrowError('Invalid name');
+      expect(exec.exec).not.toHaveBeenCalled();
+    });
+
+    it('should throw error if volume removal fails', async () => {
+      const output = { ok: false, stdout: '' };
+      execMocks.exec = jest.fn().mockResolvedValue(output);
+
+      await expect(vm.delete({ name: 'failed' })).rejects.toThrowError('Unable to remove volume');
+    });
+  });
+
+  describe('prune', () => {
+    it('should remove ununsed volumes', async () => {
+      const execOutput = { ok: true, stdout: '' };
+      execMocks.exec = jest.fn().mockResolvedValue(execOutput);
+
+      await expect(vm.prune()).resolves.toEqual('');
+
+      expect(exec.exec).toHaveBeenCalledWith('docker', ['volume', 'prune']);
+    });
+  });
+});

package/src/index.ts

@@ -0,0 +1,75 @@
+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');
+
+interface NameOption {
+  name: string;
+}
+
+async function list() {
+  const output = await exec('docker', ['volume', 'ls', '--format="{{.Name}}"']);
+
+  if (!output.ok) {
+    throw new Error('Unable to list volumes');
+  }
+
+  return output.stdout.trim().split('\n');
+}
+
+async function show(options: NameOption) {
+  if (!isValidName(options.name)) {
+    throw invalidNameError;
+  }
+
+  const output = await exec('docker', ['volume', 'inspect', options.name]);
+  const list = JSON.parse(output.stdout);
+
+  if (!list.length) {
+    throw new Error('Volume not found');
+  }
+
+  const { Name, Labels, CreatedAt } = list[0];
+
+  return {
+    name: Name,
+    createdAt: CreatedAt,
+    labels: Labels,
+  };
+}
+
+async function add(options: NameOption) {
+  if (!isValidName(options.name)) {
+    throw invalidNameError;
+  }
+
+  const output = await exec('docker', ['volume', 'create', options.name]);
+
+  if (output.ok) {
+    return '';
+  }
+
+  throw new Error('Unable to create volume');
+}
+
+async function remove(options: NameOption) {
+  if (!isValidName(options.name)) {
+    throw invalidNameError;
+  }
+
+  const output = await exec('docker', ['volume', 'rm', options.name]);
+
+  if (output.ok) {
+    return '';
+  }
+
+  throw new Error('Unable to remove volume');
+}
+
+async function prune() {
+  await exec('docker', ['volume', 'prune']);
+  return '';
+}
+
+export default { add, list, show, delete: remove, prune };