feat(xo-web): 5.50.0

Fixes xoa-support#1676

For now, the delay is set to 10s which is the duration used by xo-web's
subscription, which makes it enough to make it independent of the number of
clients.

In the future, this should probably be longer and configurable, but this
requires invalidating the cache in case of changes (creation/deletion of
backups) and explicit requests from the users, which will be implemented in
another PR.

.eslintrc.js

@@ -1,5 +1,7 @@
 module.exports = {
   extends: [
+    'plugin:eslint-comments/recommended',
+
     'standard',
     'standard-jsx',
     'prettier',
@@ -19,7 +21,7 @@ module.exports = {
 
   overrides: [
     {
-      files: ['packages/*cli*/**/*.js', '*-cli.js'],
+      files: ['cli.js', '*-cli.js', 'packages/*cli*/**/*.js'],
       rules: {
         'no-console': 'off',
       },
@@ -33,6 +35,11 @@ module.exports = {
     },
   },
   rules: {
+    // disabled because XAPI objects are using camel case
+    camelcase: ['off'],
+
+    'react/jsx-handler-names': 'off',
+
     'no-console': ['error', { allow: ['warn', 'error'] }],
     'no-var': 'error',
     'node/no-extraneous-import': 'error',

@xen-orchestra/async-map/package.json

@@ -37,7 +37,7 @@
     "@babel/preset-flow": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -46,6 +46,7 @@
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
     "prepare": "yarn run build",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/cr-seed-cli/package.json

@@ -16,6 +16,9 @@
   },
   "dependencies": {
     "golike-defer": "^0.4.1",
-    "xen-api": "^0.25.1"
+    "xen-api": "^0.27.1"
+  },
+  "scripts": {
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/cron/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xen-orchestra/cron",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "license": "ISC",
   "description": "Focused, well maintained, cron parser/scheduler",
   "keywords": [
@@ -47,7 +47,7 @@
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -55,6 +55,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run clean",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/cron/src/index.js

@@ -5,9 +5,16 @@ import parse from './parse'
 
 const MAX_DELAY = 2 ** 31 - 1
 
+function nextDelay(schedule) {
+  const now = schedule._createDate()
+  return next(schedule._schedule, now) - now
+}
+
 class Job {
   constructor(schedule, fn) {
     const wrapper = () => {
+      this._isRunning = true
+
       let result
       try {
         result = fn()
@@ -22,23 +29,34 @@ class Job {
       }
     }
     const scheduleNext = () => {
-      const delay = schedule._nextDelay()
-      this._timeout =
-        delay < MAX_DELAY
-          ? setTimeout(wrapper, delay)
-          : setTimeout(scheduleNext, MAX_DELAY)
+      this._isRunning = false
+
+      if (this._isEnabled) {
+        const delay = nextDelay(schedule)
+        this._timeout =
+          delay < MAX_DELAY
+            ? setTimeout(wrapper, delay)
+            : setTimeout(scheduleNext, MAX_DELAY)
+      }
     }
 
+    this._isEnabled = false
+    this._isRunning = false
     this._scheduleNext = scheduleNext
     this._timeout = undefined
   }
 
   start() {
     this.stop()
-    this._scheduleNext()
+
+    this._isEnabled = true
+    if (!this._isRunning) {
+      this._scheduleNext()
+    }
   }
 
   stop() {
+    this._isEnabled = false
     clearTimeout(this._timeout)
   }
 }
@@ -68,11 +86,6 @@ class Schedule {
     return dates
   }
 
-  _nextDelay() {
-    const now = this._createDate()
-    return next(this._schedule, now) - now
-  }
-
   startJob(fn) {
     const job = this.createJob(fn)
     job.start()

@xen-orchestra/cron/src/index.spec.js

@@ -0,0 +1,62 @@
+/* eslint-env jest */
+
+import { createSchedule } from './'
+
+describe('issues', () => {
+  test('stop during async execution', async () => {
+    let nCalls = 0
+    let resolve, promise
+
+    const job = createSchedule('* * * * *').createJob(() => {
+      ++nCalls
+
+      // eslint-disable-next-line promise/param-names
+      promise = new Promise(r => {
+        resolve = r
+      })
+      return promise
+    })
+
+    job.start()
+    jest.runAllTimers()
+
+    expect(nCalls).toBe(1)
+
+    job.stop()
+
+    resolve()
+    await promise
+
+    jest.runAllTimers()
+    expect(nCalls).toBe(1)
+  })
+
+  test('stop then start during async job execution', async () => {
+    let nCalls = 0
+    let resolve, promise
+
+    const job = createSchedule('* * * * *').createJob(() => {
+      ++nCalls
+
+      // eslint-disable-next-line promise/param-names
+      promise = new Promise(r => {
+        resolve = r
+      })
+      return promise
+    })
+
+    job.start()
+    jest.runAllTimers()
+
+    expect(nCalls).toBe(1)
+
+    job.stop()
+    job.start()
+
+    resolve()
+    await promise
+
+    jest.runAllTimers()
+    expect(nCalls).toBe(2)
+  })
+})

@xen-orchestra/defined/package.json

@@ -35,7 +35,7 @@
     "@babel/preset-flow": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -43,6 +43,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/emit-async/package.json

@@ -34,7 +34,7 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -42,6 +42,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/fs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xen-orchestra/fs",
-  "version": "0.8.0",
+  "version": "0.10.1",
   "license": "AGPL-3.0",
   "description": "The File System for Xen Orchestra backups.",
   "keywords": [],
@@ -21,18 +21,19 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@marsaud/smb2": "^0.13.0",
+    "@marsaud/smb2": "^0.14.0",
     "@sindresorhus/df": "^2.1.0",
     "@xen-orchestra/async-map": "^0.0.0",
     "decorator-synchronized": "^0.5.0",
     "execa": "^1.0.0",
-    "fs-extra": "^7.0.0",
+    "fs-extra": "^8.0.1",
     "get-stream": "^4.0.0",
+    "limit-concurrency-decorator": "^0.4.0",
     "lodash": "^4.17.4",
-    "promise-toolbox": "^0.12.1",
+    "promise-toolbox": "^0.13.0",
     "readable-stream": "^3.0.6",
     "through2": "^3.0.0",
-    "tmp": "^0.0.33",
+    "tmp": "^0.1.0",
     "xo-remote-parser": "^0.5.0"
   },
   "devDependencies": {
@@ -40,14 +41,15 @@
     "@babel/core": "^7.0.0",
     "@babel/plugin-proposal-decorators": "^7.1.6",
     "@babel/plugin-proposal-function-bind": "^7.0.0",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.4.4",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
     "async-iterator-to-stream": "^1.1.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "dotenv": "^7.0.0",
+    "dotenv": "^8.0.0",
     "index-modules": "^0.3.0",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -55,6 +57,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run clean",
-    "prepare": "yarn run build"
+    "prepare": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/fs/src/abstract.js

@@ -4,6 +4,7 @@
 import getStream from 'get-stream'
 
 import asyncMap from '@xen-orchestra/async-map'
+import limit from 'limit-concurrency-decorator'
 import path from 'path'
 import synchronized from 'decorator-synchronized'
 import { fromCallback, fromEvent, ignoreErrors, timeout } from 'promise-toolbox'
@@ -31,6 +32,7 @@ const computeRate = (hrtime: number[], size: number) => {
 }
 
 const DEFAULT_TIMEOUT = 6e5 // 10 min
+const DEFAULT_MAX_PARALLEL_OPERATIONS = 10
 
 const ignoreEnoent = error => {
   if (error == null || error.code !== 'ENOENT') {
@@ -83,6 +85,25 @@ export default class RemoteHandlerAbstract {
       }
     }
     ;({ timeout: this._timeout = DEFAULT_TIMEOUT } = options)
+
+    const sharedLimit = limit(
+      options.maxParallelOperations ?? DEFAULT_MAX_PARALLEL_OPERATIONS
+    )
+    this.closeFile = sharedLimit(this.closeFile)
+    this.getInfo = sharedLimit(this.getInfo)
+    this.getSize = sharedLimit(this.getSize)
+    this.list = sharedLimit(this.list)
+    this.mkdir = sharedLimit(this.mkdir)
+    this.openFile = sharedLimit(this.openFile)
+    this.outputFile = sharedLimit(this.outputFile)
+    this.read = sharedLimit(this.read)
+    this.readFile = sharedLimit(this.readFile)
+    this.rename = sharedLimit(this.rename)
+    this.rmdir = sharedLimit(this.rmdir)
+    this.truncate = sharedLimit(this.truncate)
+    this.unlink = sharedLimit(this.unlink)
+    this.write = sharedLimit(this.write)
+    this.writeFile = sharedLimit(this.writeFile)
   }
 
   // Public members
@@ -400,6 +421,10 @@ export default class RemoteHandlerAbstract {
     }
   }
 
+  async truncate(file: string, len: number): Promise<void> {
+    await this._truncate(file, len)
+  }
+
   async unlink(file: string, { checksum = true }: Object = {}): Promise<void> {
     file = normalizePath(file)
 
@@ -410,6 +435,18 @@ export default class RemoteHandlerAbstract {
     await this._unlink(file).catch(ignoreEnoent)
   }
 
+  async write(
+    file: File,
+    buffer: Buffer,
+    position: number
+  ): Promise<{| bytesWritten: number, buffer: Buffer |}> {
+    await this._write(
+      typeof file === 'string' ? normalizePath(file) : file,
+      buffer,
+      position
+    )
+  }
+
   async writeFile(
     file: string,
     data: Data,
@@ -546,6 +583,28 @@ export default class RemoteHandlerAbstract {
     throw new Error('Not implemented')
   }
 
+  async _write(file: File, buffer: Buffer, position: number): Promise<void> {
+    const isPath = typeof file === 'string'
+    if (isPath) {
+      file = await this.openFile(file, 'r+')
+    }
+    try {
+      return await this._writeFd(file, buffer, position)
+    } finally {
+      if (isPath) {
+        await this.closeFile(file)
+      }
+    }
+  }
+
+  async _writeFd(
+    fd: FileDescriptor,
+    buffer: Buffer,
+    position: number
+  ): Promise<void> {
+    throw new Error('Not implemented')
+  }
+
   async _writeFile(
     file: string,
     data: Data,

@xen-orchestra/fs/src/fs.spec.js

@@ -3,9 +3,9 @@
 import 'dotenv/config'
 import asyncIteratorToStream from 'async-iterator-to-stream'
 import getStream from 'get-stream'
+import { forOwn, random } from 'lodash'
 import { fromCallback } from 'promise-toolbox'
 import { pipeline } from 'readable-stream'
-import { random } from 'lodash'
 import { tmpdir } from 'os'
 
 import { getHandler } from '.'
@@ -310,5 +310,70 @@ handlers.forEach(url => {
         await handler.unlink('file')
       })
     })
+
+    describe('#write()', () => {
+      beforeEach(() => handler.outputFile('file', TEST_DATA))
+
+      const PATCH_DATA_LEN = Math.ceil(TEST_DATA_LEN / 2)
+      const PATCH_DATA = unsecureRandomBytes(PATCH_DATA_LEN)
+
+      forOwn(
+        {
+          'dont increase file size': (() => {
+            const offset = random(0, TEST_DATA_LEN - PATCH_DATA_LEN)
+
+            const expected = Buffer.from(TEST_DATA)
+            PATCH_DATA.copy(expected, offset)
+
+            return { offset, expected }
+          })(),
+          'increase file size': (() => {
+            const offset = random(
+              TEST_DATA_LEN - PATCH_DATA_LEN + 1,
+              TEST_DATA_LEN
+            )
+
+            const expected = Buffer.alloc(offset + PATCH_DATA_LEN)
+            TEST_DATA.copy(expected)
+            PATCH_DATA.copy(expected, offset)
+
+            return { offset, expected }
+          })(),
+        },
+        ({ offset, expected }, title) => {
+          describe(title, () => {
+            testWithFileDescriptor('file', 'r+', async ({ file }) => {
+              await handler.write(file, PATCH_DATA, offset)
+              await expect(await handler.readFile('file')).toEqual(expected)
+            })
+          })
+        }
+      )
+    })
+
+    describe('#truncate()', () => {
+      forOwn(
+        {
+          'shrinks file': (() => {
+            const length = random(0, TEST_DATA_LEN)
+            const expected = TEST_DATA.slice(0, length)
+            return { length, expected }
+          })(),
+          'grows file': (() => {
+            const length = random(TEST_DATA_LEN, TEST_DATA_LEN * 2)
+            const expected = Buffer.alloc(length)
+            TEST_DATA.copy(expected)
+            return { length, expected }
+          })(),
+        },
+        ({ length, expected }, title) => {
+          it(title, async () => {
+            await handler.outputFile('file', TEST_DATA)
+            await handler.truncate('file', length)
+            await expect(await handler.readFile('file')).toEqual(expected)
+          })
+        }
+      )
+    })
   })
 })

@xen-orchestra/fs/src/local.js

@@ -106,10 +106,18 @@ export default class LocalHandler extends RemoteHandlerAbstract {
     await fs.access(path, fs.R_OK | fs.W_OK)
   }
 
+  _truncate(file, len) {
+    return fs.truncate(this._getFilePath(file), len)
+  }
+
   async _unlink(file) {
     return fs.unlink(this._getFilePath(file))
   }
 
+  _writeFd(file, buffer, position) {
+    return fs.write(file.fd, buffer, 0, buffer.length, position)
+  }
+
   _writeFile(file, data, { flags }) {
     return fs.writeFile(this._getFilePath(file), data, { flag: flags })
   }

@xen-orchestra/fs/src/smb.js

@@ -155,10 +155,20 @@ export default class SmbHandler extends RemoteHandlerAbstract {
     return this.list('.')
   }
 
+  _truncate(file, len) {
+    return this._client
+      .truncate(this._getFilePath(file), len)
+      .catch(normalizeError)
+  }
+
   _unlink(file) {
     return this._client.unlink(this._getFilePath(file)).catch(normalizeError)
   }
 
+  _writeFd(file, buffer, position) {
+    return this._client.write(file.fd, buffer, 0, buffer.length, position)
+  }
+
   _writeFile(file, data, options) {
     return this._client
       .writeFile(this._getFilePath(file), data, options)

@xen-orchestra/log/README.md

@@ -24,6 +24,19 @@ log.info('this information is relevant to the user')
 log.warn('something went wrong but did not prevent current action')
 log.error('something went wrong')
 log.fatal('service/app is going down')
+
+// you can add contextual info
+log.debug('new API request', {
+  method: 'foo',
+  params: [ 'bar', 'baz' ]
+  user: 'qux'
+})
+
+// by convention, errors go into the `error` field
+log.error('could not join server', {
+  error,
+  server: 'example.org',
+})
 ```
 
 Then, at application level, configure the logs are handled:

@xen-orchestra/log/package.json

@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "lodash": "^4.17.4",
-    "promise-toolbox": "^0.12.1"
+    "promise-toolbox": "^0.13.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
@@ -40,7 +40,7 @@
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
     "index-modules": "^0.3.0",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -48,6 +48,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/log/src/transports/console.js

@@ -1,10 +1,12 @@
 import LEVELS, { NAMES } from '../levels'
 
 // Bind console methods (necessary for browsers)
+/* eslint-disable no-console */
 const debugConsole = console.log.bind(console)
 const infoConsole = console.info.bind(console)
 const warnConsole = console.warn.bind(console)
 const errorConsole = console.error.bind(console)
+/* eslint-enable no-console */
 
 const { ERROR, INFO, WARN } = LEVELS
 

@xen-orchestra/log/src/transports/syslog.js

@@ -1,7 +1,6 @@
 import fromCallback from 'promise-toolbox/fromCallback'
-import splitHost from 'split-host' // eslint-disable-line node/no-extraneous-import node/no-missing-import
-import startsWith from 'lodash/startsWith'
-import { createClient, Facility, Severity, Transport } from 'syslog-client' // eslint-disable-line node/no-extraneous-import node/no-missing-import
+import splitHost from 'split-host'
+import { createClient, Facility, Severity, Transport } from 'syslog-client'
 
 import LEVELS from '../levels'
 
@@ -19,10 +18,10 @@ const facility = Facility.User
 export default target => {
   const opts = {}
   if (target !== undefined) {
-    if (startsWith(target, 'tcp://')) {
+    if (target.startsWith('tcp://')) {
       target = target.slice(6)
       opts.transport = Transport.Tcp
-    } else if (startsWith(target, 'udp://')) {
+    } else if (target.startsWith('udp://')) {
       target = target.slice(6)
       opts.transport = Transport.Udp
     }

@xen-orchestra/mixin/package.json

@@ -37,7 +37,7 @@
     "babel-plugin-dev": "^1.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -45,6 +45,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/template/.babelrc.js

@@ -0,0 +1,3 @@
+module.exports = require('../../@xen-orchestra/babel-config')(
+  require('./package.json')
+)

@xen-orchestra/template/README.md

@@ -0,0 +1,62 @@
+# @xen-orchestra/template [![Build Status](https://travis-ci.org/vatesfr/xen-orchestra.png?branch=master)](https://travis-ci.org/vatesfr/xen-orchestra)
+
+## Install
+
+Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/template):
+
+```
+> npm install --save @xen-orchestra/template
+```
+
+## Usage
+
+Create a string replacer based on a pattern and a list of rules.
+
+```js
+const myReplacer = compileTemplate('{name}_COPY_\{name}_{id}_%\%', {
+  '{name}': vm => vm.name_label,
+  '{id}': vm => vm.id,
+  '%': (_, i) => i
+})
+
+const newString = myReplacer({
+  name_label: 'foo',
+  id: 42,
+}, 32)
+
+newString === 'foo_COPY_{name}_42_32%' // true
+```
+
+## Development
+
+```
+# Install dependencies
+> yarn
+
+# Run the tests
+> yarn test
+
+# Continuously compile
+> yarn dev
+
+# Continuously run the tests
+> yarn dev-test
+
+# Build for production (automatically called by npm install)
+> yarn build
+```
+
+## Contributions
+
+Contributions are *very* welcomed, either on the documentation or on
+the code.
+
+You may:
+
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
+  you've encountered;
+- fork and create a pull request.
+
+## License
+
+ISC © [Vates SAS](https://vates.fr)

@xen-orchestra/template/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@xen-orchestra/template",
+  "version": "0.1.0",
+  "license": "ISC",
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/template",
+  "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
+  "repository": {
+    "directory": "@xen-orchestra/template",
+    "type": "git",
+    "url": "https://github.com/vatesfr/xen-orchestra.git"
+  },
+  "author": {
+    "name": "Julien Fontanet",
+    "email": "julien.fontanet@vates.fr"
+  },
+  "preferGlobal": false,
+  "main": "dist/",
+  "files": [
+    "dist/"
+  ],
+  "browserslist": [
+    ">2%"
+  ],
+  "engines": {
+    "node": ">=6"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.0.0",
+    "@babel/core": "^7.0.0",
+    "@babel/preset-env": "^7.0.0",
+    "cross-env": "^5.1.3",
+    "rimraf": "^3.0.0"
+  },
+  "scripts": {
+    "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
+    "clean": "rimraf dist/",
+    "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
+    "prebuild": "yarn run clean",
+    "predev": "yarn run prebuild",
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish --access public"
+  },
+  "dependencies": {
+    "lodash": "^4.17.15"
+  }
+}

@xen-orchestra/template/src/index.js

@@ -0,0 +1,19 @@
+import escapeRegExp from 'lodash/escapeRegExp'
+
+const compareLengthDesc = (a, b) => b.length - a.length
+
+export function compileTemplate(pattern, rules) {
+  const matches = Object.keys(rules)
+    .sort(compareLengthDesc)
+    .map(escapeRegExp)
+    .join('|')
+  const regExp = new RegExp(`\\\\(?:\\\\|${matches})|${matches}`, 'g')
+  return (...params) =>
+    pattern.replace(regExp, match => {
+      if (match[0] === '\\') {
+        return match.slice(1)
+      }
+      const rule = rules[match]
+      return typeof rule === 'function' ? rule(...params) : rule
+    })
+}

@xen-orchestra/template/src/index.spec.js

@@ -0,0 +1,14 @@
+/* eslint-env jest */
+import { compileTemplate } from '.'
+
+it("correctly replaces the template's variables", () => {
+  const replacer = compileTemplate(
+    '{property}_\\{property}_\\\\{property}_{constant}_%_FOO',
+    {
+      '{property}': obj => obj.name,
+      '{constant}': 1235,
+      '%': (_, i) => i,
+    }
+  )
+  expect(replacer({ name: 'bar' }, 5)).toBe('bar_{property}_\\bar_1235_5_FOO')
+})

CHANGELOG.md

@@ -1,5 +1,223 @@
 # ChangeLog
 
+## **next**
+
+### Enhancements
+
+- [SR/new] Clarify address formats [#4450](https://github.com/vatesfr/xen-orchestra/issues/4450) (PR [#4460](https://github.com/vatesfr/xen-orchestra/pull/4460))
+- [Backup NG/New] Show warning if zstd compression is not supported on a VM [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PRs [#4411](https://github.com/vatesfr/xen-orchestra/pull/4411))
+
+### Bug fixes
+
+- [PBD] Obfuscate cifs password from device config [#4384](https://github.com/vatesfr/xen-orchestra/issues/4384) (PR [#4401](https://github.com/vatesfr/xen-orchestra/pull/4401))
+- [XOSAN] Fix "invalid parameters" error on creating a SR (PR [#4478](https://github.com/vatesfr/xen-orchestra/pull/4478))
+- [Patching] Avoid overloading XCP-ng by reducing the frequency of yum update checks [#4358](https://github.com/vatesfr/xen-orchestra/issues/4358) (PR [#4477](https://github.com/vatesfr/xen-orchestra/pull/4477))
+- [Network] Fix inability to create a bonded network (PR [#4489](https://github.com/vatesfr/xen-orchestra/pull/4489))
+- [Backup restore & Replication] Don't copy `sm_config` to new VDIs which might leads to useless coalesces [#4482](https://github.com/vatesfr/xen-orchestra/issues/4482) (PR [#4484](https://github.com/vatesfr/xen-orchestra/pull/4484))
+- [Home] Fix intermediary "no results" display showed on filtering items [#4420](https://github.com/vatesfr/xen-orchestra/issues/4420) (PR [#4456](https://github.com/vatesfr/xen-orchestra/pull/4456)
+
+### Released packages
+
+- xo-server-sdn-controller v0.2.1
+- xo-server v5.49.0
+- xo-web v5.49.0
+
+## **5.38.0** (2019-08-29)
+
+![Channel: latest](https://badgen.net/badge/channel/latest/yellow)
+
+### Enhancements
+
+- [VM/Attach disk] Display confirmation modal when VDI is already attached [#3381](https://github.com/vatesfr/xen-orchestra/issues/3381) (PR [#4366](https://github.com/vatesfr/xen-orchestra/pull/4366))
+- [Zstd]
+  - [VM/copy, VM/export] Only show zstd option when it's supported [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PRs [#4326](https://github.com/vatesfr/xen-orchestra/pull/4326) [#4368](https://github.com/vatesfr/xen-orchestra/pull/4368))
+  - [VM/Bulk copy] Show warning if zstd compression is not supported on a VM [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PR [#4346](https://github.com/vatesfr/xen-orchestra/pull/4346))
+- [VM import & Continuous Replication] Enable `guessVhdSizeOnImport` by default, this fix some `VDI_IO_ERROR` with XenServer 7.1 and XCP-ng 8.0 (PR [#4436](https://github.com/vatesfr/xen-orchestra/pull/4436))
+- [SDN Controller] Add possibility to create multiple GRE networks and VxLAN networks within a same pool (PR [#4435](https://github.com/vatesfr/xen-orchestra/pull/4435))
+- [SDN Controller] Add possibility to create cross-pool private networks (PR [#4405](https://github.com/vatesfr/xen-orchestra/pull/4405))
+
+### Bug fixes
+
+- [SR/General] Display VDI VM name in SR usage graph (PR [#4370](https://github.com/vatesfr/xen-orchestra/pull/4370))
+- [VM/Attach disk] Fix checking VDI mode (PR [#4373](https://github.com/vatesfr/xen-orchestra/pull/4373))
+- [VM revert] Snapshot before: add admin ACLs on created snapshot [#4331](https://github.com/vatesfr/xen-orchestra/issues/4331) (PR [#4391](https://github.com/vatesfr/xen-orchestra/pull/4391))
+- [Network] Fixed "invalid parameters" error when creating bonded network [#4425](https://github.com/vatesfr/xen-orchestra/issues/4425) (PR [#4429](https://github.com/vatesfr/xen-orchestra/pull/4429))
+
+### Released packages
+
+- xo-server-sdn-controller v0.2.0
+- xo-server-usage-report v0.7.3
+- xo-server v5.48.0
+- xo-web v5.48.1
+
+## **5.37.1** (2019-08-06)
+
+![Channel: stable](https://badgen.net/badge/channel/stable/green)
+
+### Enhancements
+
+- [SDN Controller] Let the user choose on which PIF to create a private network (PR [#4379](https://github.com/vatesfr/xen-orchestra/pull/4379))
+
+### Bug fixes
+
+- [SDN Controller] Better detect host shutting down to adapt network topology (PR [#4314](https://github.com/vatesfr/xen-orchestra/pull/4314))
+- [SDN Controller] Add new hosts to pool's private networks (PR [#4382](https://github.com/vatesfr/xen-orchestra/pull/4382))
+
+### Released packages
+
+- xo-server-sdn-controller v0.1.2
+
+## **5.37.0** (2019-07-25)
+
+### Highlights
+
+- [Pool] Ability to add multiple hosts on the pool [#2402](https://github.com/vatesfr/xen-orchestra/issues/2402) (PR [#3716](https://github.com/vatesfr/xen-orchestra/pull/3716))
+- [SR/General] Improve SR usage graph [#3608](https://github.com/vatesfr/xen-orchestra/issues/3608) (PR [#3830](https://github.com/vatesfr/xen-orchestra/pull/3830))
+- [VM] Permission to revert to any snapshot for VM operators [#3928](https://github.com/vatesfr/xen-orchestra/issues/3928) (PR [#4247](https://github.com/vatesfr/xen-orchestra/pull/4247))
+- [Backup NG] Ability to bypass unhealthy VDI chains check [#4324](https://github.com/vatesfr/xen-orchestra/issues/4324) (PR [#4340](https://github.com/vatesfr/xen-orchestra/pull/4340))
+- [VM/console] Multiline copy/pasting [#4261](https://github.com/vatesfr/xen-orchestra/issues/4261) (PR [#4341](https://github.com/vatesfr/xen-orchestra/pull/4341))
+
+### Enhancements
+
+- [Stats] Ability to display last day stats [#4160](https://github.com/vatesfr/xen-orchestra/issues/4160) (PR [#4168](https://github.com/vatesfr/xen-orchestra/pull/4168))
+- [Settings/servers] Display servers connection issues [#4300](https://github.com/vatesfr/xen-orchestra/issues/4300) (PR [#4310](https://github.com/vatesfr/xen-orchestra/pull/4310))
+- [VM] Show current operations and progress [#3811](https://github.com/vatesfr/xen-orchestra/issues/3811) (PR [#3982](https://github.com/vatesfr/xen-orchestra/pull/3982))
+- [Backup NG/New] Generate default schedule if no schedule is specified [#4036](https://github.com/vatesfr/xen-orchestra/issues/4036) (PR [#4183](https://github.com/vatesfr/xen-orchestra/pull/4183))
+- [Host/Advanced] Ability to edit iSCSI IQN [#4048](https://github.com/vatesfr/xen-orchestra/issues/4048) (PR [#4208](https://github.com/vatesfr/xen-orchestra/pull/4208))
+- [VM,host] Improved state icons/pills (colors and tooltips) (PR [#4363](https://github.com/vatesfr/xen-orchestra/pull/4363))
+
+### Bug fixes
+
+- [Settings/Servers] Fix read-only setting toggling
+- [SDN Controller] Do not choose physical PIF without IP configuration for tunnels. (PR [#4319](https://github.com/vatesfr/xen-orchestra/pull/4319))
+- [Xen servers] Fix `no connection found for object` error if pool master is reinstalled [#4299](https://github.com/vatesfr/xen-orchestra/issues/4299) (PR [#4302](https://github.com/vatesfr/xen-orchestra/pull/4302))
+- [Backup-ng/restore] Display correct size for full VM backup [#4316](https://github.com/vatesfr/xen-orchestra/issues/4316) (PR [#4332](https://github.com/vatesfr/xen-orchestra/pull/4332))
+- [VM/tab-advanced] Fix CPU limits edition (PR [#4337](https://github.com/vatesfr/xen-orchestra/pull/4337))
+- [Remotes] Fix `EIO` errors due to massive parallel fs operations [#4323](https://github.com/vatesfr/xen-orchestra/issues/4323) (PR [#4330](https://github.com/vatesfr/xen-orchestra/pull/4330))
+- [VM/Advanced] Fix virtualization mode switch (PV/HVM) (PR [#4349](https://github.com/vatesfr/xen-orchestra/pull/4349))
+- [Task] fix hidden notification by search field [#3874](https://github.com/vatesfr/xen-orchestra/issues/3874) (PR [#4305](https://github.com/vatesfr/xen-orchestra/pull/4305)
+- [VM] Fail to change affinity (PR [#4361](https://github.com/vatesfr/xen-orchestra/pull/4361)
+- [VM] Number of CPUs not correctly changed on running VMs (PR [#4360](https://github.com/vatesfr/xen-orchestra/pull/4360)
+
+### Released packages
+
+- @xen-orchestra/fs v0.10.1
+- xo-server-sdn-controller v0.1.1
+- xen-api v0.27.1
+- xo-server v5.46.0
+- xo-web v5.46.0
+
+## **5.36.0** (2019-06-27)
+
+### Highlights
+
+- [SR/new] Create ZFS storage [#4260](https://github.com/vatesfr/xen-orchestra/issues/4260) (PR [#4266](https://github.com/vatesfr/xen-orchestra/pull/4266))
+- [Host/advanced] Fix host CPU hyperthreading detection [#4262](https://github.com/vatesfr/xen-orchestra/issues/4262) (PR [#4285](https://github.com/vatesfr/xen-orchestra/pull/4285))
+- [VM/Advanced] Ability to use UEFI instead of BIOS [#4264](https://github.com/vatesfr/xen-orchestra/issues/4264) (PR [#4268](https://github.com/vatesfr/xen-orchestra/pull/4268))
+- [Backup-ng/restore] Display size for full VM backup [#4009](https://github.com/vatesfr/xen-orchestra/issues/4009) (PR [#4245](https://github.com/vatesfr/xen-orchestra/pull/4245))
+- [Sr/new] Ability to select NFS version when creating NFS storage [#3951](https://github.com/vatesfr/xen-orchestra/issues/3951) (PR [#4277](https://github.com/vatesfr/xen-orchestra/pull/4277))
+- [Host/storages, SR/hosts] Display PBD details [#4264](https://github.com/vatesfr/xen-orchestra/issues/4161) (PR [#4268](https://github.com/vatesfr/xen-orchestra/pull/4284))
+- [auth-saml] Improve compatibility with Microsoft Azure Active Directory (PR [#4294](https://github.com/vatesfr/xen-orchestra/pull/4294))
+
+### Enhancements
+
+- [Host] Display warning when "Citrix Hypervisor" license has restrictions [#4251](https://github.com/vatesfr/xen-orchestra/issues/4164) (PR [#4235](https://github.com/vatesfr/xen-orchestra/pull/4279))
+- [VM/Backup] Create backup bulk action [#2573](https://github.com/vatesfr/xen-orchestra/issues/2573) (PR [#4257](https://github.com/vatesfr/xen-orchestra/pull/4257))
+- [Host] Display warning when host's time differs too much from XOA's time [#4113](https://github.com/vatesfr/xen-orchestra/issues/4113) (PR [#4173](https://github.com/vatesfr/xen-orchestra/pull/4173))
+- [VM/network] Display and set bandwidth rate-limit of a VIF [#4215](https://github.com/vatesfr/xen-orchestra/issues/4215) (PR [#4293](https://github.com/vatesfr/xen-orchestra/pull/4293))
+- [SDN Controller] New plugin which enables creating pool-wide private networks [xcp-ng/xcp#175](https://github.com/xcp-ng/xcp/issues/175) (PR [#4269](https://github.com/vatesfr/xen-orchestra/pull/4269))
+
+### Bug fixes
+
+- [XOA] Don't require editing the _email_ field in case of re-registration (PR [#4259](https://github.com/vatesfr/xen-orchestra/pull/4259))
+- [Metadata backup] Missing XAPIs should trigger a failure job [#4281](https://github.com/vatesfr/xen-orchestra/issues/4281) (PR [#4283](https://github.com/vatesfr/xen-orchestra/pull/4283))
+- [iSCSI] Fix fibre channel paths display [#4291](https://github.com/vatesfr/xen-orchestra/issues/4291) (PR [#4303](https://github.com/vatesfr/xen-orchestra/pull/4303))
+- [New VM] Fix tooltips not displayed on disabled elements in some browsers (e.g. Google Chrome) [#4304](https://github.com/vatesfr/xen-orchestra/issues/4304) (PR [#4309](https://github.com/vatesfr/xen-orchestra/pull/4309))
+
+### Released packages
+
+- xo-server-auth-ldap v0.6.5
+- xen-api v0.26.0
+- xo-server-sdn-controller v0.1
+- xo-server-auth-saml v0.6.0
+- xo-server-backup-reports v0.16.2
+- xo-server v5.44.0
+- xo-web v5.44.0
+
+## **5.35.0** (2019-05-29)
+
+### Enhancements
+
+- [VM/general] Display 'Started... ago' instead of 'Halted... ago' for paused state [#3750](https://github.com/vatesfr/xen-orchestra/issues/3750) (PR [#4170](https://github.com/vatesfr/xen-orchestra/pull/4170))
+- [Metadata backup] Ability to define when the backup report will be sent (PR [#4149](https://github.com/vatesfr/xen-orchestra/pull/4149))
+- [XOA/Update] Ability to select release channel [#4200](https://github.com/vatesfr/xen-orchestra/issues/4200) (PR [#4202](https://github.com/vatesfr/xen-orchestra/pull/4202))
+- [User] Forget connection tokens on password change or on demand [#4214](https://github.com/vatesfr/xen-orchestra/issues/4214) (PR [#4224](https://github.com/vatesfr/xen-orchestra/pull/4224))
+- [Settings/Logs] LICENCE_RESTRICTION errors: suggest XCP-ng as an Open Source alternative [#3876](https://github.com/vatesfr/xen-orchestra/issues/3876) (PR [#4238](https://github.com/vatesfr/xen-orchestra/pull/4238))
+- [VM/Migrate] Display VDI size on migrate modal [#2534](https://github.com/vatesfr/xen-orchestra/issues/2534) (PR [#4250](https://github.com/vatesfr/xen-orchestra/pull/4250))
+- [Host] Display hyperthreading status on advanced tab [#4262](https://github.com/vatesfr/xen-orchestra/issues/4262) (PR [#4263](https://github.com/vatesfr/xen-orchestra/pull/4263))
+
+### Bug fixes
+
+- [Pool/Patches] Fix "an error has occurred" in "Applied patches" [#4192](https://github.com/vatesfr/xen-orchestra/issues/4192) (PR [#4193](https://github.com/vatesfr/xen-orchestra/pull/4193))
+- [Backup NG] Fix report sent even though "Never" is selected [#4092](https://github.com/vatesfr/xen-orchestra/issues/4092) (PR [#4178](https://github.com/vatesfr/xen-orchestra/pull/4178))
+- [Remotes] Fix issues after a config import (PR [#4197](https://github.com/vatesfr/xen-orchestra/pull/4197))
+- [Charts] Fixed the chart lines sometimes changing order/color (PR [#4221](https://github.com/vatesfr/xen-orchestra/pull/4221))
+- Prevent non-admin users to access admin pages with URL (PR [#4220](https://github.com/vatesfr/xen-orchestra/pull/4220))
+- [Upgrade] Fix alert before upgrade while running backup jobs [#4164](https://github.com/vatesfr/xen-orchestra/issues/4164) (PR [#4235](https://github.com/vatesfr/xen-orchestra/pull/4235))
+- [Import] Fix import OVA files (PR [#4232](https://github.com/vatesfr/xen-orchestra/pull/4232))
+- [VM/network] Fix duplicate IPv4 (PR [#4239](https://github.com/vatesfr/xen-orchestra/pull/4239))
+- [Remotes] Fix disconnected remotes which may appear to work
+- [Host] Fix incorrect hypervisor name [#4246](https://github.com/vatesfr/xen-orchestra/issues/4246) (PR [#4248](https://github.com/vatesfr/xen-orchestra/pull/4248))
+
+### Released packages
+
+- xo-server-backup-reports v0.16.1
+- @xen-orchestra/fs v0.9.0
+- vhd-lib v0.7.0
+- xo-server v5.42.1
+- xo-web v5.42.1
+
+## **5.34.0** (2019-04-30)
+
+### Highlights
+
+- [Self/New VM] Add network config box to custom cloud-init [#3872](https://github.com/vatesfr/xen-orchestra/issues/3872) (PR [#4150](https://github.com/vatesfr/xen-orchestra/pull/4150))
+- [Metadata backup] Detailed logs [#4005](https://github.com/vatesfr/xen-orchestra/issues/4005) (PR [#4014](https://github.com/vatesfr/xen-orchestra/pull/4014))
+- [Backup reports] Support metadata backups (PR [#4084](https://github.com/vatesfr/xen-orchestra/pull/4084))
+- [VM migration] Auto select default SR and collapse optional actions [#3326](https://github.com/vatesfr/xen-orchestra/issues/3326) (PR [#4121](https://github.com/vatesfr/xen-orchestra/pull/4121))
+- Unlock basic stats on all editions [#4166](https://github.com/vatesfr/xen-orchestra/issues/4166) (PR [#4172](https://github.com/vatesfr/xen-orchestra/pull/4172))
+
+### Enhancements
+
+- [Settings/remotes] Expose mount options field for SMB [#4063](https://github.com/vatesfr/xen-orchestra/issues/4063) (PR [#4067](https://github.com/vatesfr/xen-orchestra/pull/4067))
+- [Backup/Schedule] Add warning regarding DST when you add a schedule [#4042](https://github.com/vatesfr/xen-orchestra/issues/4042) (PR [#4056](https://github.com/vatesfr/xen-orchestra/pull/4056))
+- [Import] Avoid blocking the UI when dropping a big OVA file on the UI (PR [#4018](https://github.com/vatesfr/xen-orchestra/pull/4018))
+- [Backup NG/Overview] Make backup list title clearer [#4111](https://github.com/vatesfr/xen-orchestra/issues/4111) (PR [#4129](https://github.com/vatesfr/xen-orchestra/pull/4129))
+- [Dashboard] Hide "Report" section for non-admins [#4123](https://github.com/vatesfr/xen-orchestra/issues/4123) (PR [#4126](https://github.com/vatesfr/xen-orchestra/pull/4126))
+- [Self/New VM] Display confirmation modal when user will use a large amount of resources [#4044](https://github.com/vatesfr/xen-orchestra/issues/4044) (PR [#4127](https://github.com/vatesfr/xen-orchestra/pull/4127))
+- [VDI migration, New disk] Warning when SR host is different from the other disks [#3911](https://github.com/vatesfr/xen-orchestra/issues/3911) (PR [#4035](https://github.com/vatesfr/xen-orchestra/pull/4035))
+- [Attach disk] Display warning message when VDI SR is on different host from the other disks [#3911](https://github.com/vatesfr/xen-orchestra/issues/3911) (PR [#4117](https://github.com/vatesfr/xen-orchestra/pull/4117))
+- [Editable] Notify user when editable undo fails [#3799](https://github.com/vatesfr/xen-orchestra/issues/3799) (PR [#4150](https://github.com/vatesfr/xen-orchestra/pull/4157))
+- [XO] Add banner for sources users to clarify support conditions [#4165](https://github.com/vatesfr/xen-orchestra/issues/4165) (PR [#4167](https://github.com/vatesfr/xen-orchestra/pull/4167))
+
+### Bug fixes
+
+- [Continuous Replication] Fix VHD size guess for empty files [#4105](https://github.com/vatesfr/xen-orchestra/issues/4105)  (PR [#4107](https://github.com/vatesfr/xen-orchestra/pull/4107))
+- [Backup NG] Only display full backup interval in case of a delta backup (PR [#4125](https://github.com/vatesfr/xen-orchestra/pull/4107))
+- [Dashboard/Health] fix 'an error has occurred' on the storage state table [#4128](https://github.com/vatesfr/xen-orchestra/issues/4128)  (PR [#4132](https://github.com/vatesfr/xen-orchestra/pull/4132))
+- [Menu] XOA: Fixed empty slot when menu is collapsed [#4012](https://github.com/vatesfr/xen-orchestra/issues/4012) (PR [#4068](https://github.com/vatesfr/xen-orchestra/pull/4068)
+- [Self/New VM] Fix missing templates when refreshing page [#3265](https://github.com/vatesfr/xen-orchestra/issues/3265) (PR [#3565](https://github.com/vatesfr/xen-orchestra/pull/3565))
+- [Home] No more false positives when select Tag on Home page [#4087](https://github.com/vatesfr/xen-orchestra/issues/4087) (PR [#4112](https://github.com/vatesfr/xen-orchestra/pull/4112))
+
+### Released packages
+
+- xo-server-backup-reports v0.16.0
+- complex-matcher v0.6.0
+- xo-vmdk-to-vhd v0.1.7
+- vhd-lib v0.6.1
+- xo-server v5.40.0
+- xo-web v5.40.1
+
 ## **5.33.1** (2019-04-04)
 
 ### Bug fix

CHANGELOG.unreleased.md

@@ -1,18 +1,43 @@
 > This file contains all changes that have not been released yet.
+>
+> Keep in mind the changelog is addressed to **users** and should be
+> understandable by them.
 
 ### Enhancements
 
-- [Settings/remotes] Expose mount options field for SMB [#4063](https://github.com/vatesfr/xen-orchestra/issues/4063) (PR [#4067](https://github.com/vatesfr/xen-orchestra/pull/4067))
-- [Backup/Schedule] Add warning regarding DST when you add a schedule [#4042](https://github.com/vatesfr/xen-orchestra/issues/4042) (PR [#4056](https://github.com/vatesfr/xen-orchestra/pull/4056))
-- [Import] Avoid blocking the UI when dropping a big OVA file on the UI (PR [#4018](https://github.com/vatesfr/xen-orchestra/pull/4018))
+> Users must be able to say: “Nice enhancement, I'm eager to test it”
+
+- [VM/disks] Don't hide disks that are attached to the same VM twice [#4400](https://github.com/vatesfr/xen-orchestra/issues/4400) (PR [#4414](https://github.com/vatesfr/xen-orchestra/pull/4414))
+- [VM/console] Add a button to connect to the VM via the local SSH client (PR [#4415](https://github.com/vatesfr/xen-orchestra/pull/4415))
+- [SDN Controller] Add possibility to encrypt private networks (PR [#4441](https://github.com/vatesfr/xen-orchestra/pull/4441))
+- [SDN Controller] Ability to configure MTU for private networks (PR [#4491](https://github.com/vatesfr/xen-orchestra/pull/4491))
+- [VM Export] Filenames are now prefixed with datetime [#4503](https://github.com/vatesfr/xen-orchestra/issues/4503)
+- [Backups] Improve performance by caching VM backups listing (PR [#4509](https://github.com/vatesfr/xen-orchestra/pull/4509))
 
 ### Bug fixes
 
-- [Continuous Replication] Fix VHD size guess for empty files [#4105](https://github.com/vatesfr/xen-orchestra/issues/4105)  (PR [#4107](https://github.com/vatesfr/xen-orchestra/pull/4107))
+- [Backup NG/New schedule] Properly show user errors in the form [#3831](https://github.com/vatesfr/xen-orchestra/issues/3831) (PR [#4131](https://github.com/vatesfr/xen-orchestra/pull/4131))
+
+> Users must be able to say: “I had this issue, happy to know it's fixed”
+
+- [VM/Advanced] Fix `"vm.set_domain_type" is not a function` error on switching virtualization mode (PV/HVM) [#4348](https://github.com/vatesfr/xen-orchestra/issues/4348) (PR [#4504](https://github.com/vatesfr/xen-orchestra/pull/4504))
+- [Backup NG/logs] Show warning when zstd compression is selected but not supported [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PR [#4375](https://github.com/vatesfr/xen-orchestra/pull/4375)
+- [Patches] Fix patches installation for CH 8.0 (PR [#4511](https://github.com/vatesfr/xen-orchestra/pull/4511))
+- [Network] Fix inability to set a network name [#4514](https://github.com/vatesfr/xen-orchestra/issues/4514) (PR [4510](https://github.com/vatesfr/xen-orchestra/pull/4510))
+- [Backup NG] Fix race conditions that could lead to disabled jobs still running (PR [4510](https://github.com/vatesfr/xen-orchestra/pull/4510))
+- [XOA] Remove "Updates" and "Licenses" tabs for non admin users (PR [#4526](https://github.com/vatesfr/xen-orchestra/pull/4526))
+- [New VM] Ability to escape [cloud config template](https://xen-orchestra.com/blog/xen-orchestra-5-21/#cloudconfigtemplates) variables [#4486](https://github.com/vatesfr/xen-orchestra/issues/4486) (PR [#4501](https://github.com/vatesfr/xen-orchestra/pull/4501))
+- [Backup NG] Properly log and report if job is already running [#4497](https://github.com/vatesfr/xen-orchestra/issues/4497) (PR [4534](https://github.com/vatesfr/xen-orchestra/pull/4534))
 
 ### Released packages
 
-- xo-vmdk-to-vhd v0.1.7
-- vhd-lib v0.6.1
-- xo-server v5.39.0
-- xo-web v5.39.0
+> Packages will be released in the order they are here, therefore, they should
+> be listed by inverse order of dependency.
+>
+> Rule of thumb: add packages on top.
+
+- @xen-orchestra/template v0.0.0
+- @xen-orchestra/cron v1.0.4
+- xo-server-sdn-controller v0.3.0
+- xo-server v5.50.0
+- xo-web v5.50.0

PULL_REQUEST_TEMPLATE.md

@@ -4,6 +4,7 @@
 
 - [ ] PR reference the relevant issue (e.g. `Fixes #007`)
 - [ ] if UI changes, a screenshot has been added to the PR
+- [ ] if `xo-server` API changes, the corresponding test has been added to/updated on [`xo-server-test`](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-server-test)
 - [ ] `CHANGELOG.unreleased.md`:
    - enhancement/bug fix entry added
    - list of packages to release updated (`${name} v${new version}`)
@@ -14,5 +15,5 @@
 
 1. create a PR as soon as possible
 1. mark it as `WiP:` (Work in Progress) if not ready to be merged
-1. when you want a review, add a reviewer
+1. when you want a review, add a reviewer (and only one)
 1. if necessary, update your PR, and re- add a reviewer

README.md

@@ -1,4 +1,4 @@
-# Xen Orchestra [![Chat with us](https://storage.crisp.im/plugins/images/936925df-f37b-4ba8-bab0-70cd2edcb0be/badge.svg)](https://go.crisp.im/chat/embed/?website_id=-JzqzzwddSV7bKGtEyAQ) [![Build Status](https://travis-ci.org/vatesfr/xen-orchestra.png?branch=master)](https://travis-ci.org/vatesfr/xen-orchestra)
+# Xen Orchestra [![Build Status](https://travis-ci.org/vatesfr/xen-orchestra.png?branch=master)](https://travis-ci.org/vatesfr/xen-orchestra)
 
 ![](http://i.imgur.com/tRffA5y.png)
 

docs/README.md

@@ -13,11 +13,11 @@ It aims to be easy to use on any device supporting modern web technologies (HTML
 
 ## XOA quick deploy
 
-SSH to your XenServer, and execute the following:
+Log in to your account and use the deploy form available on [this page](https://xen-orchestra.com/#!/xoa)
 
-```
-bash -c "$(curl -s http://xoa.io/deploy)"
-```
+> **Note:** no data will be sent to our servers, it's running only between your browser and your host!
+
+[![](./assets/deploy_form.png)](https://xen-orchestra.com/#!/xoa)
 
 ### XOA credentials
 

docs/SUMMARY.md

@@ -55,6 +55,7 @@
    * [Emergency Shutdown](emergency_shutdown.md)
    * [Auto scalability](auto_scalability.md)
    * [Forecaster](forecaster.md)
+   * [SDN Controller](sdn_controller.md)
 * [Recipes](recipes.md)
    * [Reverse proxy](reverse_proxy.md)
 * [How to contribute?](contributing.md)

docs/features.md

@@ -15,5 +15,6 @@ We've made multiple categories to help you to find what you need:
 * [Job Manager](scheduler.html)
 * [Alerts](alerts.html)
 * [Load balancing](load_balancing.html)
+* [SDN Controller](sdn_controller.html)
 
 ![](./assets/xo5tablet.jpg)

docs/installation.md

@@ -1,14 +1,10 @@
 
 # Installation
 
-SSH to your XenServer and execute the following:
+Log in to your account and use the deploy form available on [this page](https://xen-orchestra.com/#!/xoa)
 
-```
-bash -c "$(curl -s http://xoa.io/deploy)"
-```
+![](./assets/deploy_form.png)
 
-This will automatically download/import/start the XOA appliance. Nothing is changed on your XenServer host itself, it's 100% safe.
-
-## [More on XOA](xoa.md)
+## [More on XOA and alternate deploy](xoa.md)
 
 ![](https://xen-orchestra.com/assets/xoa1.png)

docs/sdn_controller.md

@@ -0,0 +1,60 @@
+# SDN Controller
+
+> SDN Controller is available in XOA 5.44 and higher
+
+The SDN Controller enables a user to **create pool-wide and cross-pool** (since XOA 5.48.1) **private networks**.
+
+![](./assets/sdn-controller.png)
+
+## How does it work?
+
+Please read the [dedicated devblog on the SDN Controller](https://xen-orchestra.com/blog/xo-sdn-controller/) and its [extension for cross-pool private networks](https://xen-orchestra.com/blog/devblog-3-extending-the-sdn-controller/).
+
+## Usage
+
+### Network creation
+
+In the network creation view:
+- Select a `pool`
+- Select `Private network`
+- Select an interface on which to create the network's tunnels
+- Select the encapsulation: a choice is offered between `GRE` and `VxLAN`, if `VxLAN` is chosen, then port 4789 must be open for UDP traffic on all the network's hosts (see [the requirements](#vxlan))
+- Choose if the network should be encrypted or not (see [the requirements](#encryption) to use encryption)
+- Select other `pool`s to add them to the network if desired
+  - For each added `pool`: select an interface on which to create the tunnels
+- Create the network
+- Have fun! ☺
+
+***NB:***
+- All hosts in a private network must be able to reach the other hosts' management interface.
+> The term ‘management interface’ is used to indicate the IP-enabled NIC that carries the management traffic.
+- Only 1 encrypted GRE network and 1 encrypted VxLAN network per pool can exist at a time due to Open vSwitch limitation.
+
+### Configuration
+
+Like all other xo-server plugins, it can be configured directly via
+the web interface, see [the plugin documentation](https://xen-orchestra.com/docs/plugins.html).
+
+The plugin's configuration contains:
+- `cert-dir`: The path where the plugin will look for the certificates to create SSL connections with the hosts.
+If none is provided, the plugin will create its own self-signed certificates.
+- `override-certs`: Enable to uninstall the existing SDN controller CA certificate in order to replace it with the plugin's one.
+
+## Requirements
+
+### VxLAN
+
+- On XCP-ng prior to 7.6:
+  - To be able to use `VxLAN`, the following line needs to be added, if not already present, in `/etc/sysconfig/iptables` of all the hosts where `VxLAN` is wanted: `-A xapi-INPUT -p udp -m conntrack --ctstate NEW -m udp --dport 4789 -j ACCEPT`
+
+### Encryption
+
+> Encryption is not available prior to 8.0.
+
+- On XCP-ng 8.0:
+  - To be able to encrypt the networks, `openvswitch-ipsec` package must be installed on all the hosts:
+    - `yum install openvswitch-ipsec --enablerepo=xcp-ng-testing`
+    - `systemctl enable ipsec`
+    - `systemctl enable openvswitch-ipsec`
+    - `systemctl start ipsec`
+    - `systemctl start openvswitch-ipsec`

docs/support.md

@@ -1,24 +1,33 @@
 # Support
 
-You can access our pro support if you subscribe to any of these plans:
+Xen Orchestra will run in a controlled/tested environment thanks to XOA ([Xen Orchestra virtual Appliance](https://xen-orchestra.com/#!/xoa)). **This is the way to get pro support**. Any account with a registered XOA can access a [dedicated support panel](https://xen-orchestra.com/#!/member/support).
 
+XOA is available in multiple plans:
+
+* Free  
 * Starter
 * Enterprise
 * Premium
 
-The better the plan, the faster the support will be with higher priority.
+Higher tier support plans include faster ticket response times (and cover more features). Paid support plans and response times are based on the plan you have, plans can be [reviewed here](https://xen-orchestra.com/#!/xo-pricing).
+
+## XOA Free support
+
+With the free version of the Xen Orchestra Appliance (XOA free), you can open support tickets and we will do our best to assist you, however, this support is limited and is not guaranteed in regards to response times or resolutions offered.
 
 ## Community support
 
-If you are using Xen Orchestra via the sources, you can ask questions and try to recieve help two different ways:
+If you are using Xen Orchestra via the source and not XOA, you can ask questions and try to recieve help through a number of different ways:
 
-* In our [forum](https://xen-orchestra.com/forum/)
+* In our [forum](https://xcp-ng.org/forum/category/12/xen-orchestra)
 * In our IRC - `#xen-orchestra` on `Freenode`
 
-However, there's no guarantee you will receive an answer and no guaranteed response time. If you are using XO from sources, we encourage you to give back to the community by assisting other users via these two avenues as well.  
+We encourage you to give back to the community by assisting other users via these two avenues as well.
 
-If you are using Xen Orchestra in production, please subscribe to a plan.
+Lastly while Xen Orchestra is free and Open Source software, supporting and developing it takes a lot of effort. If you are considering using Xen Orchestra in production, please subscribe for one of our [professional support plans](https://xen-orchestra.com/#!/xo-pricing).
+
+> Note: support from the sources is harder, because Xen Orchestra can potentially run on any Linux distro (or even FreeBSD and Windows!). Always try to double check that you followed our guide on how to [install it from the sources](https://xen-orchestra.com/docs/from_the_sources.html) before going further.
 
 ## Open a ticket
 
-If you have a subscription, you can open a ticket describing your issue directly from your personal account page [here](https://xen-orchestra.com/#!/member/support)
+If you have a subscription (or at least a registered free XOA), you can open a ticket describing your issue directly from your personal account page [here](https://xen-orchestra.com/#!/member/support)

docs/troubleshooting.md

@@ -110,16 +110,17 @@ $ systemctl restart xo-server
 
 ### Behind a transparent proxy
 
-If your are behind a transparent proxy, you'll probably have issues with the updater (SSL/TLS issues).
+If you're behind a transparent proxy, you'll probably have issues with the updater (SSL/TLS issues).
 
-First, run the following commands:
+Run the following commands to allow the updater to work:
 
 ```
+$ sudo -s
 $ echo NODE_TLS_REJECT_UNAUTHORIZED=0 >> /etc/xo-appliance/env
 $ npm config -g set strict-ssl=false
+$ systemctl restart xoa-updater
 ```
-
-Then, restart the updater with `systemctl restart xoa-updater`.
+Now try running an update again.
 
 ### Updating SSL self-signed certificate
 

docs/xoa.md

@@ -22,26 +22,36 @@ For use on huge infrastructure (more than 500+ VMs), feel free to increase the R
 
 ### The quickest way
 
-The fastest way to install Xen Orchestra is to use our appliance deploy script. You can deploy it by connecting to your XenServer host and executing the following:
+The **fastest and most secure way** to install Xen Orchestra is to use our web deploy page. Go on https://xen-orchestra.com/#!/xoa and follow instructions.
+
+> **Note:** no data will be sent to our servers, it's running only between your browser and your host!
+
+![](./assets/deploy_form.png)
+
+### Via a bash script
+
+Alternatively, you can deploy it by connecting to your XenServer host and executing the following:
 
 ```
 bash -c "$(curl -s http://xoa.io/deploy)"
 ```
-**Note:** This won't write or modify anything on your XenServer host: it will just import the XOA VM into your default storage repository.  
 
-Now follow the instructions:
+> **Note:** This won't write or modify anything on your XenServer host: it will just import the XOA VM into your default storage repository.
+
+Follow the instructions:
 
 * Your IP configuration will be requested: it's set to **DHCP by default**, otherwise you can enter a fixed IP address (eg `192.168.0.10`)
 * If DHCP is selected, the script will continue automatically. Otherwise a netmask, gateway, and DNS should be provided.
 * XOA will be deployed on your default storage repository. You can move it elsewhere anytime after.
 
-### The alternative
+### Via download the XVA
 
 Download XOA from xen-orchestra.com. Once you've got the XVA file, you can import it with `xe vm-import filename=xoa_unified.xva` or via XenCenter.
 
 After the VM is imported, you just need to start it with `xe vm-start vm="XOA"` or with XenCenter.
 
 ## First Login
+
 Once you have started the VM, you can access the web UI by putting the IP you configured during deployment into your web browser. If you did not configure an IP or are unsure, try one of the following methods to find it:  
 
 * Run `xe vm-list params=name-label,networks | grep -A 1 XOA` on your host

package.json

@@ -6,23 +6,24 @@
     "babel-eslint": "^10.0.1",
     "babel-jest": "^24.1.0",
     "benchmark": "^2.1.4",
-    "eslint": "^5.1.0",
-    "eslint-config-prettier": "^4.1.0",
-    "eslint-config-standard": "12.0.0",
-    "eslint-config-standard-jsx": "^6.0.2",
+    "eslint": "^6.0.1",
+    "eslint-config-prettier": "^6.0.0",
+    "eslint-config-standard": "14.1.0",
+    "eslint-config-standard-jsx": "^8.1.0",
+    "eslint-plugin-eslint-comments": "^3.1.1",
     "eslint-plugin-import": "^2.8.0",
-    "eslint-plugin-node": "^8.0.0",
+    "eslint-plugin-node": "^9.0.1",
     "eslint-plugin-promise": "^4.0.0",
     "eslint-plugin-react": "^7.6.1",
     "eslint-plugin-standard": "^4.0.0",
     "exec-promise": "^0.7.0",
-    "flow-bin": "^0.95.1",
-    "globby": "^9.0.0",
-    "husky": "^1.2.1",
+    "flow-bin": "^0.106.3",
+    "globby": "^10.0.0",
+    "husky": "^3.0.0",
     "jest": "^24.1.0",
     "lodash": "^4.17.4",
     "prettier": "^1.10.2",
-    "promise-toolbox": "^0.12.1",
+    "promise-toolbox": "^0.13.0",
     "sorted-object": "^2.0.1"
   },
   "engines": {
@@ -41,9 +42,11 @@
     "testEnvironment": "node",
     "testPathIgnorePatterns": [
       "/dist/",
+      "/xo-server-test/",
       "/xo-web/"
     ],
     "testRegex": "\\.spec\\.js$",
+    "timers": "fake",
     "transform": {
       "\\.jsx?$": "babel-jest"
     }

packages/complex-matcher/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complex-matcher",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "license": "ISC",
   "description": "",
   "keywords": [],
@@ -36,7 +36,7 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.1",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -44,6 +44,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/complex-matcher/src/index.js

@@ -599,6 +599,13 @@ export const parse = parser.parse.bind(parser)
 
 // -------------------------------------------------------------------
 
+const _extractStringFromRegexp = child => {
+  const unescapedRegexp = child.re.source.replace(/^(\^)|\\|\$$/g, '')
+  if (child.re.source === `^${escapeRegExp(unescapedRegexp)}$`) {
+    return unescapedRegexp
+  }
+}
+
 const _getPropertyClauseStrings = ({ child }) => {
   if (child instanceof Or) {
     const strings = []
@@ -606,6 +613,12 @@ const _getPropertyClauseStrings = ({ child }) => {
       if (child instanceof StringNode) {
         strings.push(child.value)
       }
+      if (child instanceof RegExpNode) {
+        const unescapedRegexp = _extractStringFromRegexp(child)
+        if (unescapedRegexp !== undefined) {
+          strings.push(unescapedRegexp)
+        }
+      }
     })
     return strings
   }
@@ -613,6 +626,12 @@ const _getPropertyClauseStrings = ({ child }) => {
   if (child instanceof StringNode) {
     return [child.value]
   }
+  if (child instanceof RegExpNode) {
+    const unescapedRegexp = _extractStringFromRegexp(child)
+    if (unescapedRegexp !== undefined) {
+      return [unescapedRegexp]
+    }
+  }
 
   return []
 }

packages/complex-matcher/src/index.spec.js

@@ -12,10 +12,13 @@ import {
 } from './'
 
 it('getPropertyClausesStrings', () => {
-  const tmp = getPropertyClausesStrings(parse('foo bar:baz baz:|(foo bar)'))
+  const tmp = getPropertyClausesStrings(
+    parse('foo bar:baz baz:|(foo bar /^boo$/ /^far$/) foo:/^bar$/')
+  )
   expect(tmp).toEqual({
     bar: ['baz'],
-    baz: ['foo', 'bar'],
+    baz: ['foo', 'bar', 'boo', 'far'],
+    foo: ['bar'],
   })
 })
 

packages/value-matcher/package.json

@@ -34,7 +34,7 @@
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -43,6 +43,7 @@
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
     "prepare": "yarn run build",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/vhd-cli/package.json

@@ -27,12 +27,12 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@xen-orchestra/fs": "^0.8.0",
-    "cli-progress": "^2.0.0",
+    "@xen-orchestra/fs": "^0.10.1",
+    "cli-progress": "^3.1.0",
     "exec-promise": "^0.7.0",
     "getopts": "^2.2.3",
     "struct-fu": "^1.2.0",
-    "vhd-lib": "^0.6.0"
+    "vhd-lib": "^0.7.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
@@ -40,17 +40,18 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "execa": "^1.0.0",
+    "execa": "^2.0.2",
     "index-modules": "^0.3.0",
-    "promise-toolbox": "^0.12.1",
-    "rimraf": "^2.6.1",
-    "tmp": "^0.0.33"
+    "promise-toolbox": "^0.13.0",
+    "rimraf": "^3.0.0",
+    "tmp": "^0.1.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "rimraf dist/ && index-modules --cjs-lazy src/commands",
     "predev": "yarn run prebuild",
-    "prepare": "yarn run build"
+    "prepare": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/vhd-lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vhd-lib",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "license": "AGPL-3.0",
   "description": "Primitives for VHD file handling",
   "keywords": [],
@@ -22,11 +22,11 @@
   },
   "dependencies": {
     "async-iterator-to-stream": "^1.0.2",
-    "core-js": "3.0.0",
+    "core-js": "^3.0.0",
     "from2": "^2.3.0",
-    "fs-extra": "^7.0.0",
+    "fs-extra": "^8.0.1",
     "limit-concurrency-decorator": "^0.4.0",
-    "promise-toolbox": "^0.12.1",
+    "promise-toolbox": "^0.13.0",
     "struct-fu": "^1.2.0",
     "uuid": "^3.0.1"
   },
@@ -35,16 +35,16 @@
     "@babel/core": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
-    "@xen-orchestra/fs": "^0.8.0",
+    "@xen-orchestra/fs": "^0.10.1",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "execa": "^1.0.0",
+    "execa": "^2.0.2",
     "fs-promise": "^2.0.0",
-    "get-stream": "^4.0.0",
+    "get-stream": "^5.1.0",
     "index-modules": "^0.3.0",
     "readable-stream": "^3.0.6",
-    "rimraf": "^2.6.2",
-    "tmp": "^0.0.33"
+    "rimraf": "^3.0.0",
+    "tmp": "^0.1.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -52,6 +52,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run clean",
-    "prepare": "yarn run build"
+    "prepare": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/vhd-lib/src/vhd.js

@@ -1,9 +1,7 @@
 import assert from 'assert'
-import { fromEvent } from 'promise-toolbox'
 
 import checkFooter from './_checkFooter'
 import checkHeader from './_checkHeader'
-import constantStream from './_constant-stream'
 import getFirstAndLastBlocks from './_getFirstAndLastBlocks'
 import { fuFooter, fuHeader, checksumStruct, unpackField } from './_structs'
 import { set as mapSetBit, test as mapTestBit } from './_bitmap'
@@ -232,24 +230,11 @@ export default class Vhd {
   // Write functions.
   // =================================================================
 
-  // Write a buffer/stream at a given position in a vhd file.
+  // Write a buffer at a given position in a vhd file.
   async _write(data, offset) {
-    debug(
-      `_write offset=${offset} size=${
-        Buffer.isBuffer(data) ? data.length : '???'
-      }`
-    )
-    // TODO: could probably be merged in remote handlers.
-    const stream = await this._handler.createOutputStream(this._path, {
-      flags: 'r+',
-      start: offset,
-    })
-    return Buffer.isBuffer(data)
-      ? new Promise((resolve, reject) => {
-          stream.on('error', reject)
-          stream.end(data, resolve)
-        })
-      : fromEvent(data.pipe(stream), 'finish')
+    assert(Buffer.isBuffer(data))
+    debug(`_write offset=${offset} size=${data.length}`)
+    return this._handler.write(this._path, data, offset)
   }
 
   async _freeFirstBlockSpace(spaceNeededBytes) {
@@ -306,7 +291,7 @@ export default class Vhd {
       `ensureBatSize: extend BAT ${prevMaxTableEntries} -> ${maxTableEntries}`
     )
     await this._write(
-      constantStream(BUF_BLOCK_UNUSED, maxTableEntries - prevMaxTableEntries),
+      Buffer.alloc(maxTableEntries - prevMaxTableEntries, BUF_BLOCK_UNUSED),
       header.tableOffset + prevBat.length
     )
     await this.writeHeader()
@@ -331,10 +316,7 @@ export default class Vhd {
 
     await Promise.all([
       // Write an empty block and addr in vhd file.
-      this._write(
-        constantStream([0], this.fullBlockSize),
-        sectorsToBytes(blockAddr)
-      ),
+      this._write(Buffer.alloc(this.fullBlockSize), sectorsToBytes(blockAddr)),
 
       this._setBatEntry(blockId, blockAddr),
     ])
@@ -382,9 +364,7 @@ export default class Vhd {
     const offset = blockAddr + this.sectorsOfBitmap + beginSectorId
 
     debug(
-      `writeBlockSectors at ${offset} block=${
-        block.id
-      }, sectors=${beginSectorId}...${endSectorId}`
+      `writeBlockSectors at ${offset} block=${block.id}, sectors=${beginSectorId}...${endSectorId}`
     )
 
     for (let i = beginSectorId; i < endSectorId; ++i) {

packages/xapi-explore-sr/package.json

@@ -41,7 +41,7 @@
     "human-format": "^0.10.0",
     "lodash": "^4.17.4",
     "pw": "^0.0.4",
-    "xen-api": "^0.25.1"
+    "xen-api": "^0.27.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.1.5",
@@ -49,13 +49,14 @@
     "@babel/preset-env": "^7.1.5",
     "babel-plugin-lodash": "^3.2.11",
     "cross-env": "^5.1.4",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/xen-api/README.md

@@ -82,7 +82,7 @@ console.log(xapi.pool.$master.$resident_VMs[0].name_label)
 A CLI is provided to help exploration and discovery of the XAPI.
 
 ```
-> xen-api https://xen1.company.net root
+> xen-api xen1.company.net root
 Password: ******
 root@xen1.company.net> xapi.status
 'connected'
@@ -92,6 +92,14 @@ root@xen1.company.net> xapi.pool.$master.name_label
 'xen1'
 ```
 
+You can optionally prefix the address by a protocol: `https://` (default) or `http://`.
+
+In case of error due to invalid or self-signed certificates you can use the `--allow-unauthorized` flag (or `--au`):
+
+```
+> xen-api --au xen1.company.net root
+```
+
 To ease searches, `find()` and `findAll()` functions are available:
 
 ```

packages/xen-api/examples/package-lock.json

@@ -0,0 +1,189 @@
+{
+  "requires": true,
+  "lockfileVersion": 1,
+  "dependencies": {
+    "core-util-is": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz",
+      "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac="
+    },
+    "debug": {
+      "version": "2.6.9",
+      "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+      "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+      "requires": {
+        "ms": "2.0.0"
+      }
+    },
+    "event-loop-delay": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/event-loop-delay/-/event-loop-delay-1.0.0.tgz",
+      "integrity": "sha512-8YtyeIWHXrvTqlAhv+fmtaGGARmgStbvocERYzrZ3pwhnQULe5PuvMUTjIWw/emxssoaftfHZsJtkeY8xjiXCg==",
+      "requires": {
+        "napi-macros": "^1.8.2",
+        "node-gyp-build": "^3.7.0"
+      }
+    },
+    "getopts": {
+      "version": "2.2.5",
+      "resolved": "https://registry.npmjs.org/getopts/-/getopts-2.2.5.tgz",
+      "integrity": "sha512-9jb7AW5p3in+IiJWhQiZmmwkpLaR/ccTWdWQCtZM66HJcHHLegowh4q4tSD7gouUyeNvFWRavfK9GXosQHDpFA=="
+    },
+    "golike-defer": {
+      "version": "0.4.1",
+      "resolved": "https://registry.npmjs.org/golike-defer/-/golike-defer-0.4.1.tgz",
+      "integrity": "sha512-x8cq/Fvu32T8cnco3CBDRF+/M2LFmfSIysKfecX09uIK3cFdHcEKBTPlPnEO6lwrdxfjkOIU6dIw3EIlEJeS1A=="
+    },
+    "human-format": {
+      "version": "0.10.1",
+      "resolved": "https://registry.npmjs.org/human-format/-/human-format-0.10.1.tgz",
+      "integrity": "sha512-UzCHToSw3HI9MxH9tYzMr1JbHJbgzr6o0hZCun7sruv59S1leps21bmgpBkkwEvQon5n/2OWKH1iU7BEko02cg=="
+    },
+    "inherits": {
+      "version": "2.0.4",
+      "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+      "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
+    },
+    "isarray": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz",
+      "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE="
+    },
+    "make-error": {
+      "version": "1.3.5",
+      "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.5.tgz",
+      "integrity": "sha512-c3sIjNUow0+8swNwVpqoH4YCShKNFkMaw6oH1mNS2haDZQqkeZFlHS3dhoeEbKKmJB4vXpJucU6oH75aDYeE9g=="
+    },
+    "ms": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+      "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+    },
+    "napi-macros": {
+      "version": "1.8.2",
+      "resolved": "https://registry.npmjs.org/napi-macros/-/napi-macros-1.8.2.tgz",
+      "integrity": "sha512-Tr0DNY4RzTaBG2W2m3l7ZtFuJChTH6VZhXVhkGGjF/4cZTt+i8GcM9ozD+30Lmr4mDoZ5Xx34t2o4GJqYWDGcg=="
+    },
+    "node-gyp-build": {
+      "version": "3.9.0",
+      "resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-3.9.0.tgz",
+      "integrity": "sha512-zLcTg6P4AbcHPq465ZMFNXx7XpKKJh+7kkN699NiQWisR2uWYOWNWqRHAmbnmKiL4e9aLSlmy5U7rEMUXV59+A=="
+    },
+    "prettier-bytes": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/prettier-bytes/-/prettier-bytes-1.0.4.tgz",
+      "integrity": "sha1-mUsCqkb2mcULYle1+qp/4lV+YtY="
+    },
+    "process-nextick-args": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz",
+      "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag=="
+    },
+    "process-top": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/process-top/-/process-top-1.0.0.tgz",
+      "integrity": "sha512-er8iSmBMslOt5cgIHg9m6zilTPsuUqpEb1yfQ4bDmO80zr/e/5hNn+Tay3CJM/FOBnJo8Bt3fFiDDH6GvIgeAg==",
+      "requires": {
+        "event-loop-delay": "^1.0.0",
+        "prettier-bytes": "^1.0.4"
+      }
+    },
+    "progress-stream": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/progress-stream/-/progress-stream-2.0.0.tgz",
+      "integrity": "sha1-+sY6Cz0R3qy7CWmrzJOyFLzhntU=",
+      "requires": {
+        "speedometer": "~1.0.0",
+        "through2": "~2.0.3"
+      }
+    },
+    "promise-toolbox": {
+      "version": "0.13.0",
+      "resolved": "https://registry.npmjs.org/promise-toolbox/-/promise-toolbox-0.13.0.tgz",
+      "integrity": "sha512-Z6u7EL9/QyY1zZqeqpEiKS7ygKwZyl0JL0ouno/en6vMliZZc4AmM0aFCrDAVxEyKqj2f3SpkW0lXEfAZsNWiQ==",
+      "requires": {
+        "make-error": "^1.3.2"
+      }
+    },
+    "readable-stream": {
+      "version": "3.4.0",
+      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.4.0.tgz",
+      "integrity": "sha512-jItXPLmrSR8jmTRmRWJXCnGJsfy85mB3Wd/uINMXA65yrnFo0cPClFIUWzo2najVNSl+mx7/4W8ttlLWJe99pQ==",
+      "requires": {
+        "inherits": "^2.0.3",
+        "string_decoder": "^1.1.1",
+        "util-deprecate": "^1.0.1"
+      }
+    },
+    "safe-buffer": {
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
+      "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g=="
+    },
+    "speedometer": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/speedometer/-/speedometer-1.0.0.tgz",
+      "integrity": "sha1-zWccsGdSwivKM3Di8zREC+T8YuI="
+    },
+    "stream-parser": {
+      "version": "0.3.1",
+      "resolved": "https://registry.npmjs.org/stream-parser/-/stream-parser-0.3.1.tgz",
+      "integrity": "sha1-FhhUhpRCACGhGC/wrxkRwSl2F3M=",
+      "requires": {
+        "debug": "2"
+      }
+    },
+    "string_decoder": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz",
+      "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==",
+      "requires": {
+        "safe-buffer": "~5.1.0"
+      }
+    },
+    "throttle": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/throttle/-/throttle-1.0.3.tgz",
+      "integrity": "sha1-ijLkoV8XY9mXlIMXxevjrYpB5Lc=",
+      "requires": {
+        "readable-stream": ">= 0.3.0",
+        "stream-parser": ">= 0.0.2"
+      }
+    },
+    "through2": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/through2/-/through2-2.0.5.tgz",
+      "integrity": "sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==",
+      "requires": {
+        "readable-stream": "~2.3.6",
+        "xtend": "~4.0.1"
+      },
+      "dependencies": {
+        "readable-stream": {
+          "version": "2.3.6",
+          "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz",
+          "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==",
+          "requires": {
+            "core-util-is": "~1.0.0",
+            "inherits": "~2.0.3",
+            "isarray": "~1.0.0",
+            "process-nextick-args": "~2.0.0",
+            "safe-buffer": "~5.1.1",
+            "string_decoder": "~1.1.1",
+            "util-deprecate": "~1.0.1"
+          }
+        }
+      }
+    },
+    "util-deprecate": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+      "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8="
+    },
+    "xtend": {
+      "version": "4.0.2",
+      "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz",
+      "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ=="
+    }
+  }
+}

packages/xen-api/examples/package.json

@@ -5,7 +5,7 @@
     "human-format": "^0.10.1",
     "process-top": "^1.0.0",
     "progress-stream": "^2.0.0",
-    "promise-toolbox": "^0.11.0",
+    "promise-toolbox": "^0.13.0",
     "readable-stream": "^3.1.1",
     "throttle": "^1.0.3"
   }

packages/xen-api/examples/yarn.lock

@@ -1,179 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-
-
-core-util-is@~1.0.0:
-  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7"
-  integrity sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=
-
-debug@2:
-  version "2.6.9"
-  resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f"
-  integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==
-  dependencies:
-    ms "2.0.0"
-
-event-loop-delay@^1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/event-loop-delay/-/event-loop-delay-1.0.0.tgz#5af6282549494fd0d868c499cbdd33e027978b8c"
-  integrity sha512-8YtyeIWHXrvTqlAhv+fmtaGGARmgStbvocERYzrZ3pwhnQULe5PuvMUTjIWw/emxssoaftfHZsJtkeY8xjiXCg==
-  dependencies:
-    napi-macros "^1.8.2"
-    node-gyp-build "^3.7.0"
-
-getopts@^2.2.3:
-  version "2.2.3"
-  resolved "https://registry.yarnpkg.com/getopts/-/getopts-2.2.3.tgz#11d229775e2ec2067ed8be6fcc39d9b4bf39cf7d"
-  integrity sha512-viEcb8TpgeG05+Nqo5EzZ8QR0hxdyrYDp6ZSTZqe2M/h53Bk036NmqG38Vhf5RGirC/Of9Xql+v66B2gp256SQ==
-
-golike-defer@^0.4.1:
-  version "0.4.1"
-  resolved "https://registry.yarnpkg.com/golike-defer/-/golike-defer-0.4.1.tgz#7a1cd435d61e461305805d980b133a0f3db4e1cc"
-
-human-format@^0.10.1:
-  version "0.10.1"
-  resolved "https://registry.yarnpkg.com/human-format/-/human-format-0.10.1.tgz#107793f355912e256148d5b5dcf66a0230187ee9"
-  integrity sha512-UzCHToSw3HI9MxH9tYzMr1JbHJbgzr6o0hZCun7sruv59S1leps21bmgpBkkwEvQon5n/2OWKH1iU7BEko02cg==
-
-inherits@^2.0.3, inherits@~2.0.3:
-  version "2.0.3"
-  resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de"
-  integrity sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=
-
-isarray@~1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11"
-  integrity sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=
-
-make-error@^1.3.2:
-  version "1.3.5"
-  resolved "https://registry.yarnpkg.com/make-error/-/make-error-1.3.5.tgz#efe4e81f6db28cadd605c70f29c831b58ef776c8"
-  integrity sha512-c3sIjNUow0+8swNwVpqoH4YCShKNFkMaw6oH1mNS2haDZQqkeZFlHS3dhoeEbKKmJB4vXpJucU6oH75aDYeE9g==
-
-ms@2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
-  integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=
-
-napi-macros@^1.8.2:
-  version "1.8.2"
-  resolved "https://registry.yarnpkg.com/napi-macros/-/napi-macros-1.8.2.tgz#299265c1d8aa401351ad0675107d751228c03eda"
-  integrity sha512-Tr0DNY4RzTaBG2W2m3l7ZtFuJChTH6VZhXVhkGGjF/4cZTt+i8GcM9ozD+30Lmr4mDoZ5Xx34t2o4GJqYWDGcg==
-
-node-gyp-build@^3.7.0:
-  version "3.7.0"
-  resolved "https://registry.yarnpkg.com/node-gyp-build/-/node-gyp-build-3.7.0.tgz#daa77a4f547b9aed3e2aac779eaf151afd60ec8d"
-  integrity sha512-L/Eg02Epx6Si2NXmedx+Okg+4UHqmaf3TNcxd50SF9NQGcJaON3AtU++kax69XV7YWz4tUspqZSAsVofhFKG2w==
-
-prettier-bytes@^1.0.4:
-  version "1.0.4"
-  resolved "https://registry.yarnpkg.com/prettier-bytes/-/prettier-bytes-1.0.4.tgz#994b02aa46f699c50b6257b5faaa7fe2557e62d6"
-  integrity sha1-mUsCqkb2mcULYle1+qp/4lV+YtY=
-
-process-nextick-args@~2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.0.tgz#a37d732f4271b4ab1ad070d35508e8290788ffaa"
-  integrity sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==
-
-process-top@^1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/process-top/-/process-top-1.0.0.tgz#52892bedb581c5abf0df2d0aa5c429e34275cc7e"
-  integrity sha512-er8iSmBMslOt5cgIHg9m6zilTPsuUqpEb1yfQ4bDmO80zr/e/5hNn+Tay3CJM/FOBnJo8Bt3fFiDDH6GvIgeAg==
-  dependencies:
-    event-loop-delay "^1.0.0"
-    prettier-bytes "^1.0.4"
-
-progress-stream@^2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/progress-stream/-/progress-stream-2.0.0.tgz#fac63a0b3d11deacbb0969abcc93b214bce19ed5"
-  integrity sha1-+sY6Cz0R3qy7CWmrzJOyFLzhntU=
-  dependencies:
-    speedometer "~1.0.0"
-    through2 "~2.0.3"
-
-promise-toolbox@^0.11.0:
-  version "0.11.0"
-  resolved "https://registry.yarnpkg.com/promise-toolbox/-/promise-toolbox-0.11.0.tgz#9ed928355355395072dace3f879879504e07d1bc"
-  integrity sha512-bjHk0kq+Ke3J3zbkbbJH6kXCyQZbFHwOTrE/Et7vS0uS0tluoV+PLqU/kEyxl8aARM7v04y2wFoDo/wWAEPvjA==
-  dependencies:
-    make-error "^1.3.2"
-
-"readable-stream@>= 0.3.0", readable-stream@^3.1.1:
-  version "3.1.1"
-  resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.1.1.tgz#ed6bbc6c5ba58b090039ff18ce670515795aeb06"
-  integrity sha512-DkN66hPyqDhnIQ6Jcsvx9bFjhw214O4poMBcIMgPVpQvNy9a0e0Uhg5SqySyDKAmUlwt8LonTBz1ezOnM8pUdA==
-  dependencies:
-    inherits "^2.0.3"
-    string_decoder "^1.1.1"
-    util-deprecate "^1.0.1"
-
-readable-stream@~2.3.6:
-  version "2.3.6"
-  resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.6.tgz#b11c27d88b8ff1fbe070643cf94b0c79ae1b0aaf"
-  integrity sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==
-  dependencies:
-    core-util-is "~1.0.0"
-    inherits "~2.0.3"
-    isarray "~1.0.0"
-    process-nextick-args "~2.0.0"
-    safe-buffer "~5.1.1"
-    string_decoder "~1.1.1"
-    util-deprecate "~1.0.1"
-
-safe-buffer@~5.1.0, safe-buffer@~5.1.1:
-  version "5.1.2"
-  resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d"
-  integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==
-
-speedometer@~1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/speedometer/-/speedometer-1.0.0.tgz#cd671cb06752c22bca3370e2f334440be4fc62e2"
-  integrity sha1-zWccsGdSwivKM3Di8zREC+T8YuI=
-
-"stream-parser@>= 0.0.2":
-  version "0.3.1"
-  resolved "https://registry.yarnpkg.com/stream-parser/-/stream-parser-0.3.1.tgz#1618548694420021a1182ff0af1911c129761773"
-  integrity sha1-FhhUhpRCACGhGC/wrxkRwSl2F3M=
-  dependencies:
-    debug "2"
-
-string_decoder@^1.1.1:
-  version "1.2.0"
-  resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.2.0.tgz#fe86e738b19544afe70469243b2a1ee9240eae8d"
-  integrity sha512-6YqyX6ZWEYguAxgZzHGL7SsCeGx3V2TtOTqZz1xSTSWnqsbWwbptafNyvf/ACquZUXV3DANr5BDIwNYe1mN42w==
-  dependencies:
-    safe-buffer "~5.1.0"
-
-string_decoder@~1.1.1:
-  version "1.1.1"
-  resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.1.1.tgz#9cf1611ba62685d7030ae9e4ba34149c3af03fc8"
-  integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==
-  dependencies:
-    safe-buffer "~5.1.0"
-
-throttle@^1.0.3:
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/throttle/-/throttle-1.0.3.tgz#8a32e4a15f1763d997948317c5ebe3ad8a41e4b7"
-  integrity sha1-ijLkoV8XY9mXlIMXxevjrYpB5Lc=
-  dependencies:
-    readable-stream ">= 0.3.0"
-    stream-parser ">= 0.0.2"
-
-through2@~2.0.3:
-  version "2.0.5"
-  resolved "https://registry.yarnpkg.com/through2/-/through2-2.0.5.tgz#01c1e39eb31d07cb7d03a96a70823260b23132cd"
-  integrity sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==
-  dependencies:
-    readable-stream "~2.3.6"
-    xtend "~4.0.1"
-
-util-deprecate@^1.0.1, util-deprecate@~1.0.1:
-  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf"
-  integrity sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=
-
-xtend@~4.0.1:
-  version "4.0.1"
-  resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.1.tgz#a5c6d532be656e23db820efb943a1f04998d63af"
-  integrity sha1-pcbVMr5lbiPbgg77lDofBJmNY68=

packages/xen-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xen-api",
-  "version": "0.25.1",
+  "version": "0.27.1",
   "license": "ISC",
   "description": "Connector to the Xen API",
   "keywords": [
@@ -33,6 +33,7 @@
     "node": ">=6"
   },
   "dependencies": {
+    "bind-property-descriptor": "^1.0.0",
     "blocked": "^1.2.1",
     "debug": "^4.0.1",
     "event-to-promise": "^0.8.0",
@@ -45,7 +46,7 @@
     "make-error": "^1.3.0",
     "minimist": "^1.2.0",
     "ms": "^2.1.1",
-    "promise-toolbox": "^0.12.1",
+    "promise-toolbox": "^0.13.0",
     "pw": "0.0.4",
     "xmlrpc": "^1.3.2",
     "xo-collection": "^0.4.1"
@@ -60,7 +61,7 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -68,6 +69,7 @@
     "plot": "gnuplot -p memory-test.gnu",
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/xen-api/src/cli.js

@@ -9,6 +9,7 @@ import minimist from 'minimist'
 import pw from 'pw'
 import { asCallback, fromCallback } from 'promise-toolbox'
 import { filter, find, isArray } from 'lodash'
+import { getBoundPropertyDescriptor } from 'bind-property-descriptor'
 import { start as createRepl } from 'repl'
 
 import { createClient } from './'
@@ -25,6 +26,20 @@ function askPassword(prompt = 'Password: ') {
   })
 }
 
+const { getPrototypeOf, ownKeys } = Reflect
+function getAllBoundDescriptors(object) {
+  const descriptors = { __proto__: null }
+  let current = object
+  do {
+    ownKeys(current).forEach(key => {
+      if (!(key in descriptors)) {
+        descriptors[key] = getBoundPropertyDescriptor(current, key, object)
+      }
+    })
+  } while ((current = getPrototypeOf(current)) !== null)
+  return descriptors
+}
+
 // ===================================================================
 
 const usage = 'Usage: xen-api <url> [<user> [<password>]]'
@@ -78,11 +93,17 @@ const main = async args => {
   const repl = createRepl({
     prompt: `${xapi._humanId}> `,
   })
-  repl.context.xapi = xapi
 
-  repl.context.diff = (a, b) => console.log('%s', diff(a, b))
-  repl.context.find = predicate => find(xapi.objects.all, predicate)
-  repl.context.findAll = predicate => filter(xapi.objects.all, predicate)
+  {
+    const ctx = repl.context
+    ctx.xapi = xapi
+
+    ctx.diff = (a, b) => console.log('%s', diff(a, b))
+    ctx.find = predicate => find(xapi.objects.all, predicate)
+    ctx.findAll = predicate => filter(xapi.objects.all, predicate)
+
+    Object.defineProperties(ctx, getAllBoundDescriptors(xapi))
+  }
 
   // Make the REPL waits for promise completion.
   repl.eval = (evaluate => (cmd, context, filename, cb) => {

packages/xen-api/src/index.js

@@ -34,7 +34,7 @@ const EVENT_TIMEOUT = 60
 
 // ===================================================================
 
-const { defineProperties, freeze, keys: getKeys } = Object
+const { defineProperties, defineProperty, freeze, keys: getKeys } = Object
 
 // -------------------------------------------------------------------
 
@@ -99,6 +99,9 @@ export class Xapi extends EventEmitter {
     this._sessionId = undefined
     this._status = DISCONNECTED
 
+    this._watchEventsError = undefined
+    this._lastEventFetchedTimestamp = undefined
+
     this._debounce = opts.debounce ?? 200
     this._objects = new Collection()
     this._objectsByRef = { __proto__: null }
@@ -168,22 +171,6 @@ export class Xapi extends EventEmitter {
     try {
       await this._sessionOpen()
 
-      // Uses introspection to list available types.
-      const types = (this._types = (await this._interruptOnDisconnect(
-        this._call('system.listMethods')
-      ))
-        .filter(isGetAllRecordsMethod)
-        .map(method => method.slice(0, method.indexOf('.'))))
-      this._lcToTypes = { __proto__: null }
-      types.forEach(type => {
-        const lcType = type.toLowerCase()
-        if (lcType !== type) {
-          this._lcToTypes[lcType] = type
-        }
-      })
-
-      this._pool = (await this.getAllRecords('pool'))[0]
-
       debug('%s: connected', this._humanId)
       this._status = CONNECTED
       this._resolveConnected()
@@ -495,6 +482,14 @@ export class Xapi extends EventEmitter {
     return this._objectsFetched
   }
 
+  get lastEventFetchedTimestamp() {
+    return this._lastEventFetchedTimestamp
+  }
+
+  get watchEventsError() {
+    return this._watchEventsError
+  }
+
   // ensure we have received all events up to this call
   //
   // optionally returns the up to date object for the given ref
@@ -739,6 +734,28 @@ export class Xapi extends EventEmitter {
         },
       }
     )
+
+    const oldPoolRef = this._pool?.$ref
+    this._pool = (await this.getAllRecords('pool'))[0]
+
+    // if the pool ref has changed, it means that the XAPI has been restarted or
+    // it's not the same XAPI, we need to refetch the available types and reset
+    // the event loop in that case
+    if (this._pool.$ref !== oldPoolRef) {
+      // Uses introspection to list available types.
+      const types = (this._types = (await this._interruptOnDisconnect(
+        this._call('system.listMethods')
+      ))
+        .filter(isGetAllRecordsMethod)
+        .map(method => method.slice(0, method.indexOf('.'))))
+      this._lcToTypes = { __proto__: null }
+      types.forEach(type => {
+        const lcType = type.toLowerCase()
+        if (lcType !== type) {
+          this._lcToTypes[lcType] = type
+        }
+      })
+    }
   }
 
   _setUrl(url) {
@@ -936,21 +953,28 @@ export class Xapi extends EventEmitter {
 
         let result
         try {
-          result = await this._sessionCall(
+          // don't use _sessionCall because a session failure should break the
+          // loop and trigger a complete refetch
+          result = await this._call(
             'event.from',
             [
+              this._sessionId,
               types,
               fromToken,
               EVENT_TIMEOUT + 0.1, // must be float for XML-RPC transport
             ],
             EVENT_TIMEOUT * 1e3 * 1.1
           )
+          this._lastEventFetchedTimestamp = Date.now()
+          this._watchEventsError = undefined
         } catch (error) {
-          if (error?.code === 'EVENTS_LOST') {
+          const code = error?.code
+          if (code === 'EVENTS_LOST' || code === 'SESSION_INVALID') {
             // eslint-disable-next-line no-labels
             continue mainLoop
           }
 
+          this._watchEventsError = error
           console.warn('_watchEvents', error)
           await pDelay(this._eventPollDelay)
           continue
@@ -1023,17 +1047,23 @@ export class Xapi extends EventEmitter {
 
       const getObjectByRef = ref => this._objectsByRef[ref]
 
-      Record = function(ref, data) {
-        defineProperties(this, {
-          $id: { value: data.uuid ?? ref },
-          $ref: { value: ref },
-          $xapi: { value: xapi },
-        })
-        for (let i = 0; i < nFields; ++i) {
-          const field = fields[i]
-          this[field] = data[field]
+      Record = defineProperty(
+        function(ref, data) {
+          defineProperties(this, {
+            $id: { value: data.uuid ?? ref },
+            $ref: { value: ref },
+            $xapi: { value: xapi },
+          })
+          for (let i = 0; i < nFields; ++i) {
+            const field = fields[i]
+            this[field] = data[field]
+          }
+        },
+        'name',
+        {
+          value: type,
         }
-      }
+      )
 
       const getters = { $pool: getPool }
       const props = { $type: type }
@@ -1053,9 +1083,14 @@ export class Xapi extends EventEmitter {
             }
           }
 
-          props[`add_to_${field}`] = function(...values) {
+          props[`add_${field}`] = function(value) {
             return xapi
-              .call(`${type}.add_${field}`, this.$ref, values)
+              .call(`${type}.add_${field}`, this.$ref, value)
+              .then(noop)
+          }
+          props[`remove_${field}`] = function(value) {
+            return xapi
+              .call(`${type}.remove_${field}`, this.$ref, value)
               .then(noop)
           }
         } else if (value !== null && typeof value === 'object') {

packages/xo-acl-resolver/package.json

@@ -25,5 +25,8 @@
   },
   "dependencies": {
     "xo-common": "^0.2.0"
+  },
+  "scripts": {
+    "postversion": "npm publish"
   }
 }

packages/xo-cli/package.json

@@ -43,7 +43,7 @@
     "nice-pipe": "0.0.0",
     "pretty-ms": "^4.0.0",
     "progress-stream": "^2.0.0",
-    "promise-toolbox": "^0.12.1",
+    "promise-toolbox": "^0.13.0",
     "pump": "^3.0.0",
     "pw": "^0.0.4",
     "strip-indent": "^2.0.0",
@@ -57,13 +57,14 @@
     "@babel/preset-flow": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/xo-cli/src/index.js

@@ -24,7 +24,6 @@ const nicePipe = require('nice-pipe')
 const pairs = require('lodash/toPairs')
 const pick = require('lodash/pick')
 const pump = require('pump')
-const startsWith = require('lodash/startsWith')
 const prettyMs = require('pretty-ms')
 const progressStream = require('progress-stream')
 const pw = require('pw')
@@ -81,7 +80,7 @@ function parseParameters(args) {
     const name = matches[1]
     let value = matches[2]
 
-    if (startsWith(value, 'json:')) {
+    if (value.startsWith('json:')) {
       value = JSON.parse(value.slice(5))
     }
 
@@ -200,7 +199,18 @@ function main(args) {
     return exports[fnName](args.slice(1))
   }
 
-  return exports.call(args)
+  return exports.call(args).catch(error => {
+    if (!(error != null && error.code === 10 && 'errors' in error.data)) {
+      throw error
+    }
+
+    const lines = [error.message]
+    const { errors } = error.data
+    errors.forEach(error => {
+      lines.push(`  property ${error.property}: ${error.message}`)
+    })
+    throw lines.join('\n')
+  })
 }
 exports = module.exports = main
 

packages/xo-collection/package.json

@@ -36,13 +36,14 @@
     "@babel/preset-env": "^7.0.0",
     "cross-env": "^5.1.3",
     "event-to-promise": "^0.8.0",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/xo-common/package.json

@@ -37,7 +37,7 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -45,6 +45,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/xo-import-servers-csv/package.json

@@ -43,7 +43,7 @@
     "xo-lib": "^0.9.0"
   },
   "devDependencies": {
-    "@types/node": "^11.11.4",
+    "@types/node": "^12.0.2",
     "@types/through2": "^2.0.31",
     "tslint": "^5.9.1",
     "tslint-config-standard": "^8.0.1",
@@ -55,6 +55,7 @@
     "lint": "tslint 'src/*.ts'",
     "posttest": "yarn run lint",
     "prepublishOnly": "yarn run build",
-    "start": "node dist/index.js"
+    "start": "node dist/index.js",
+    "postversion": "npm publish"
   }
 }

packages/xo-lib/package.json

@@ -32,7 +32,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "jsonrpc-websocket-client": "^0.4.1",
+    "jsonrpc-websocket-client": "^0.5.0",
     "lodash": "^4.17.2",
     "make-error": "^1.0.4"
   },
@@ -42,13 +42,14 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/xo-lib/src/index.js

@@ -1,6 +1,5 @@
 import JsonRpcWebSocketClient, { OPEN, CLOSED } from 'jsonrpc-websocket-client'
 import { BaseError } from 'make-error'
-import { startsWith } from 'lodash'
 
 // ===================================================================
 
@@ -35,7 +34,7 @@ export default class Xo extends JsonRpcWebSocketClient {
   }
 
   call(method, args, i) {
-    if (startsWith(method, 'session.')) {
+    if (method.startsWith('session.')) {
       return Promise.reject(
         new XoError('session.*() methods are disabled from this interface')
       )

packages/xo-remote-parser/package.json

@@ -34,13 +34,14 @@
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
     "deep-freeze": "^0.0.1",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
-    "prepare": "yarn run build"
+    "prepare": "yarn run build",
+    "postversion": "npm publish"
   }
 }

packages/xo-server-auth-github/package.json

@@ -41,5 +41,6 @@
     "build": "NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "NODE_DEV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-auth-google/package.json

@@ -41,7 +41,7 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -49,5 +49,6 @@
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-auth-ldap/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xo-server-auth-ldap",
-  "version": "0.6.4",
+  "version": "0.6.5",
   "license": "AGPL-3.0",
   "description": "LDAP authentication plugin for XO-Server",
   "keywords": [
@@ -36,10 +36,10 @@
   "dependencies": {
     "event-to-promise": "^0.8.0",
     "exec-promise": "^0.7.0",
-    "inquirer": "^6.0.0",
+    "inquirer": "^7.0.0",
     "ldapjs": "^1.0.1",
     "lodash": "^4.17.4",
-    "promise-toolbox": "^0.12.1"
+    "promise-toolbox": "^0.13.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
@@ -47,7 +47,7 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -55,5 +55,6 @@
     "prebuild": "rimraf dist/",
     "predev": "yarn run prebuild",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-auth-ldap/src/index.js

@@ -230,10 +230,9 @@ class AuthLdap {
           logger(`attempting to bind as ${entry.objectName}`)
           await bind(entry.objectName, password)
           logger(
-            `successfully bound as ${
-              entry.objectName
-            } => ${username} authenticated`
+            `successfully bound as ${entry.objectName} => ${username} authenticated`
           )
+          logger(JSON.stringify(entry, null, 2))
           return { username }
         } catch (error) {
           logger(`failed to bind as ${entry.objectName}: ${error.message}`)

packages/xo-server-auth-saml/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xo-server-auth-saml",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "license": "AGPL-3.0",
   "description": "SAML authentication plugin for XO-Server",
   "keywords": [
@@ -33,7 +33,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "passport-saml": "^1.0.0"
+    "passport-saml": "^1.1.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
@@ -41,7 +41,7 @@
     "@babel/preset-env": "^7.0.0",
     "babel-preset-env": "^1.6.1",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -50,5 +50,6 @@
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-auth-saml/src/index.js

@@ -24,7 +24,10 @@ export const configurationSchema = {
     },
     usernameField: {
       title: 'Username field',
-      description: 'Field to use as the XO username',
+      description: `Field to use as the XO username
+
+You should try \`http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress\` if you are using Microsoft Azure Active Directory.
+      `,
       type: 'string',
     },
   },

packages/xo-server-backup-reports/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xo-server-backup-reports",
-  "version": "0.15.0",
+  "version": "0.16.2",
   "license": "AGPL-3.0",
   "description": "Backup reports plugin for XO-Server",
   "keywords": [
@@ -36,6 +36,7 @@
     "node": ">=6"
   },
   "dependencies": {
+    "@xen-orchestra/log": "^0.1.4",
     "human-format": "^0.10.0",
     "lodash": "^4.13.1",
     "moment-timezone": "^0.5.13"
@@ -43,10 +44,12 @@
   "devDependencies": {
     "@babel/cli": "^7.0.0",
     "@babel/core": "^7.0.0",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.4.3",
+    "@babel/plugin-proposal-optional-chaining": "^7.2.0",
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.1"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -55,5 +58,6 @@
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-backup-reports/src/index.js

@@ -1,8 +1,11 @@
+import createLogger from '@xen-orchestra/log'
 import humanFormat from 'human-format'
 import moment from 'moment-timezone'
-import { forEach, get, startCase } from 'lodash'
+import { forEach, groupBy, startCase } from 'lodash'
 import pkg from '../package'
 
+const logger = createLogger('xo:xo-server-backup-reports')
+
 export const configurationSchema = {
   type: 'object',
 
@@ -46,6 +49,9 @@ export const testSchema = {
 
 // ===================================================================
 
+const INDENT = '  '
+const UNKNOWN_ITEM = 'Unknown'
+
 const ICON_FAILURE = '🚨'
 const ICON_INTERRUPTED = '⚠️'
 const ICON_SKIPPED = '⏩'
@@ -60,7 +66,7 @@ const STATUS_ICON = {
 }
 
 const DATE_FORMAT = 'dddd, MMMM Do YYYY, h:mm:ss a'
-const createDateFormater = timezone =>
+const createDateFormatter = timezone =>
   timezone !== undefined
     ? timestamp =>
         moment(timestamp)
@@ -86,10 +92,6 @@ const formatSpeed = (bytes, milliseconds) =>
       })
     : 'N/A'
 
-const logError = e => {
-  console.error('backup report error:', e)
-}
-
 const NO_VMS_MATCH_THIS_PATTERN = 'no VMs match this pattern'
 const NO_SUCH_OBJECT_ERROR = 'no such object'
 const UNHEALTHY_VDI_CHAIN_ERROR = 'unhealthy VDI chain'
@@ -100,40 +102,116 @@ const isSkippedError = error =>
   error.message === UNHEALTHY_VDI_CHAIN_ERROR ||
   error.message === NO_SUCH_OBJECT_ERROR
 
-const INDENT = '  '
-const createGetTemporalDataMarkdown = formatDate => (
-  start,
-  end,
-  nbIndent = 0
-) => {
-  const indent = INDENT.repeat(nbIndent)
+// ===================================================================
 
-  const markdown = [`${indent}- **Start time**: ${formatDate(start)}`]
+const STATUS = ['failure', 'interrupted', 'skipped', 'success']
+const TITLE_BY_STATUS = {
+  failure: n => `## ${n} Failure${n === 1 ? '' : 's'}`,
+  interrupted: n => `## ${n} Interrupted`,
+  skipped: n => `## ${n} Skipped`,
+  success: n => `## ${n} Success${n === 1 ? '' : 'es'}`,
+}
+
+const getTemporalDataMarkdown = (end, start, formatDate) => {
+  const markdown = [`- **Start time**: ${formatDate(start)}`]
   if (end !== undefined) {
-    markdown.push(`${indent}- **End time**: ${formatDate(end)}`)
+    markdown.push(`- **End time**: ${formatDate(end)}`)
     const duration = end - start
     if (duration >= 1) {
-      markdown.push(`${indent}- **Duration**: ${formatDuration(duration)}`)
+      markdown.push(`- **Duration**: ${formatDuration(duration)}`)
     }
   }
   return markdown
 }
 
-const addWarnings = (text, warnings, nbIndent = 0) => {
-  if (warnings === undefined) {
+const getWarningsMarkdown = (warnings = []) =>
+  warnings.map(({ message }) => `- **${ICON_WARNING} ${message}**`)
+
+const getErrorMarkdown = task => {
+  let message
+  if (
+    task.status === 'success' ||
+    (message = task.result?.message ?? task.result?.code) === undefined
+  ) {
     return
   }
 
-  const indent = INDENT.repeat(nbIndent)
-  warnings.forEach(({ message }) => {
-    text.push(`${indent}- **${ICON_WARNING} ${message}**`)
-  })
+  const label = task.status === 'skipped' ? 'Reason' : 'Error'
+  return `- **${label}**: ${message}`
 }
 
+const MARKDOWN_BY_TYPE = {
+  pool(task, { formatDate }) {
+    const { id, pool = {}, poolMaster = {} } = task.data
+    const name = pool.name_label || poolMaster.name_label || UNKNOWN_ITEM
+
+    return {
+      body: [
+        pool.uuid !== undefined
+          ? `- **UUID**: ${pool.uuid}`
+          : `- **ID**: ${id}`,
+        ...getTemporalDataMarkdown(task.end, task.start, formatDate),
+        getErrorMarkdown(task),
+      ],
+      title: `[pool] ${name}`,
+    }
+  },
+  xo(task, { formatDate, jobName }) {
+    return {
+      body: [
+        ...getTemporalDataMarkdown(task.end, task.start, formatDate),
+        getErrorMarkdown(task),
+      ],
+      title: `[XO] ${jobName}`,
+    }
+  },
+  async remote(task, { formatDate, xo }) {
+    const id = task.data.id
+    const name = await xo.getRemote(id).then(
+      ({ name }) => name,
+      error => {
+        logger.warn(error)
+        return UNKNOWN_ITEM
+      }
+    )
+    return {
+      body: [
+        `- **ID**: ${id}`,
+        ...getTemporalDataMarkdown(task.end, task.start, formatDate),
+        getErrorMarkdown(task),
+      ],
+      title: `[remote] ${name}`,
+    }
+  },
+}
+
+const getMarkdown = (task, props) =>
+  MARKDOWN_BY_TYPE[(task.data?.type)]?.(task, props)
+
+const toMarkdown = parts => {
+  const lines = []
+  let indentLevel = 0
+
+  const helper = part => {
+    if (typeof part === 'string') {
+      lines.push(`${INDENT.repeat(indentLevel)}${part}`)
+    } else if (Array.isArray(part)) {
+      ++indentLevel
+      part.forEach(helper)
+      --indentLevel
+    }
+  }
+  helper(parts)
+
+  return lines.join('\n')
+}
+
+// ===================================================================
+
 class BackupReportsXoPlugin {
   constructor(xo) {
     this._xo = xo
-    this._report = this._wrapper.bind(this)
+    this._report = this._report.bind(this)
   }
 
   configure({ toMails, toXmpp }) {
@@ -146,76 +224,174 @@ class BackupReportsXoPlugin {
   }
 
   test({ runId }) {
-    return this._backupNgListener(undefined, undefined, undefined, runId)
+    return this._report(runId, undefined, true)
   }
 
   unload() {
     this._xo.removeListener('job:terminated', this._report)
   }
 
-  _wrapper(status, job, schedule, runJobId) {
-    if (job.type === 'metadataBackup') {
-      return
-    }
+  async _report(runJobId, { type, status } = {}, force) {
+    const xo = this._xo
+    try {
+      if (type === 'call') {
+        return this._legacyVmHandler(status)
+      }
 
-    return new Promise(resolve =>
-      resolve(
-        job.type === 'backup'
-          ? this._backupNgListener(status, job, schedule, runJobId)
-          : this._listener(status, job, schedule, runJobId)
-      )
-    ).catch(logError)
+      const log = await xo.getBackupNgLogs(runJobId)
+      if (log === undefined) {
+        throw new Error(`no log found with runId=${JSON.stringify(runJobId)}`)
+      }
+
+      const reportWhen = log.data.reportWhen
+      if (
+        !force &&
+        (reportWhen === 'never' ||
+          // Handle improper value introduced by:
+          // https://github.com/vatesfr/xen-orchestra/commit/753ee994f2948bbaca9d3161eaab82329a682773#diff-9c044ab8a42ed6576ea927a64c1ec3ebR105
+          reportWhen === 'Never' ||
+          (reportWhen === 'failure' && log.status === 'success'))
+      ) {
+        return
+      }
+
+      const [job, schedule] = await Promise.all([
+        await xo.getJob(log.jobId),
+        await xo.getSchedule(log.scheduleId).catch(error => {
+          logger.warn(error)
+        }),
+      ])
+
+      if (job.type === 'backup') {
+        return this._ngVmHandler(log, job, schedule, force)
+      } else if (job.type === 'metadataBackup') {
+        return this._metadataHandler(log, job, schedule, force)
+      }
+
+      throw new Error(`Unknown backup job type: ${job.type}`)
+    } catch (error) {
+      logger.warn(error)
+    }
   }
 
-  async _backupNgListener(_1, _2, schedule, runJobId) {
+  async _metadataHandler(log, { name: jobName }, schedule, force) {
     const xo = this._xo
-    const log = await xo.getBackupNgLogs(runJobId)
-    if (log === undefined) {
-      throw new Error(`no log found with runId=${JSON.stringify(runJobId)}`)
+
+    const formatDate = createDateFormatter(schedule?.timezone)
+
+    const tasksByStatus = groupBy(log.tasks, 'status')
+    const n = log.tasks?.length ?? 0
+    const nSuccesses = tasksByStatus.success?.length ?? 0
+
+    if (!force && log.data.reportWhen === 'failure') {
+      delete tasksByStatus.success
     }
 
+    // header
+    const markdown = [
+      `##  Global status: ${log.status}`,
+      '',
+      `- **Job ID**: ${log.jobId}`,
+      `- **Job name**: ${jobName}`,
+      `- **Run ID**: ${log.id}`,
+      ...getTemporalDataMarkdown(log.end, log.start, formatDate),
+      n !== 0 && `- **Successes**: ${nSuccesses} / ${n}`,
+      ...getWarningsMarkdown(log.warnings),
+      getErrorMarkdown(log),
+    ]
+
+    const nagiosText = []
+
+    // body
+    for (const status of STATUS) {
+      const tasks = tasksByStatus[status]
+      if (tasks === undefined) {
+        continue
+      }
+
+      // tasks header
+      markdown.push('---', '', TITLE_BY_STATUS[status](tasks.length))
+
+      // tasks body
+      for (const task of tasks) {
+        const taskMarkdown = await getMarkdown(task, {
+          formatDate,
+          jobName: log.jobName,
+        })
+        if (taskMarkdown === undefined) {
+          continue
+        }
+
+        const { title, body } = taskMarkdown
+        const subMarkdown = [...body, ...getWarningsMarkdown(task.warnings)]
+
+        if (task.status !== 'success') {
+          nagiosText.push(`[${task.status}] ${title}`)
+        }
+
+        for (const subTask of task.tasks ?? []) {
+          const taskMarkdown = await getMarkdown(subTask, { formatDate, xo })
+          if (taskMarkdown === undefined) {
+            continue
+          }
+
+          const icon = STATUS_ICON[subTask.status]
+          const { title, body } = taskMarkdown
+          subMarkdown.push([
+            `- **${title}** ${icon}`,
+            [...body, ...getWarningsMarkdown(subTask.warnings)],
+          ])
+        }
+        markdown.push('', '', `### ${title}`, ...subMarkdown)
+      }
+    }
+
+    // footer
+    markdown.push('---', '', `*${pkg.name} v${pkg.version}*`)
+
+    return this._sendReport({
+      subject: `[Xen Orchestra] ${log.status} − Metadata backup report for ${
+        log.jobName
+      } ${STATUS_ICON[log.status]}`,
+      markdown: toMarkdown(markdown),
+      nagiosStatus: log.status === 'success' ? 0 : 2,
+      nagiosMarkdown:
+        log.status === 'success'
+          ? `[Xen Orchestra] [Success] Metadata backup report for ${log.jobName}`
+          : `[Xen Orchestra] [${log.status}] Metadata backup report for ${
+              log.jobName
+            } - ${nagiosText.join(' ')}`,
+    })
+  }
+
+  async _ngVmHandler(log, { name: jobName }, schedule, force) {
+    const xo = this._xo
+
     const { reportWhen, mode } = log.data || {}
-    if (
-      reportWhen === 'never' ||
-      (log.status === 'success' && reportWhen === 'failure')
-    ) {
-      return
-    }
 
-    if (schedule === undefined) {
-      schedule = await xo.getSchedule(log.scheduleId)
-    }
+    const formatDate = createDateFormatter(schedule?.timezone)
 
-    const jobName = (await xo.getJob(log.jobId, 'backup')).name
-    const formatDate = createDateFormater(schedule.timezone)
-    const getTemporalDataMarkdown = createGetTemporalDataMarkdown(formatDate)
-
-    if (
-      (log.status === 'failure' || log.status === 'skipped') &&
-      log.result !== undefined
-    ) {
-      let markdown = [
+    if (log.tasks === undefined) {
+      const markdown = [
         `##  Global status: ${log.status}`,
         '',
         `- **Job ID**: ${log.jobId}`,
-        `- **Run ID**: ${runJobId}`,
+        `- **Run ID**: ${log.id}`,
         `- **mode**: ${mode}`,
-        ...getTemporalDataMarkdown(log.start, log.end),
-        `- **Error**: ${log.result.message}`,
+        ...getTemporalDataMarkdown(log.end, log.start, formatDate),
+        getErrorMarkdown(log),
+        ...getWarningsMarkdown(log.warnings),
+        '---',
+        '',
+        `*${pkg.name} v${pkg.version}*`,
       ]
-      addWarnings(markdown, log.warnings)
-      markdown.push('---', '', `*${pkg.name} v${pkg.version}*`)
-
-      markdown = markdown.join('\n')
       return this._sendReport({
         subject: `[Xen Orchestra] ${
           log.status
         } − Backup report for ${jobName} ${STATUS_ICON[log.status]}`,
-        markdown,
+        markdown: toMarkdown(markdown),
         nagiosStatus: 2,
-        nagiosMarkdown: `[Xen Orchestra] [${
-          log.status
-        }] Backup report for ${jobName} - Error : ${log.result.message}`,
+        nagiosMarkdown: `[Xen Orchestra] [${log.status}] Backup report for ${jobName} - Error : ${log.result.message}`,
       })
     }
 
@@ -231,7 +407,7 @@ class BackupReportsXoPlugin {
     let nSkipped = 0
     let nInterrupted = 0
     for (const taskLog of log.tasks) {
-      if (taskLog.status === 'success' && reportWhen === 'failure') {
+      if (!force && taskLog.status === 'success' && reportWhen === 'failure') {
         continue
       }
 
@@ -244,16 +420,16 @@ class BackupReportsXoPlugin {
         `### ${vm !== undefined ? vm.name_label : 'VM not found'}`,
         '',
         `- **UUID**: ${vm !== undefined ? vm.uuid : vmId}`,
-        ...getTemporalDataMarkdown(taskLog.start, taskLog.end),
+        ...getTemporalDataMarkdown(taskLog.end, taskLog.start, formatDate),
+        ...getWarningsMarkdown(taskLog.warnings),
       ]
-      addWarnings(text, taskLog.warnings)
 
       const failedSubTasks = []
       const snapshotText = []
       const srsText = []
       const remotesText = []
 
-      for (const subTaskLog of taskLog.tasks || []) {
+      for (const subTaskLog of taskLog.tasks ?? []) {
         if (
           subTaskLog.message !== 'export' &&
           subTaskLog.message !== 'snapshot'
@@ -262,29 +438,36 @@ class BackupReportsXoPlugin {
         }
 
         const icon = STATUS_ICON[subTaskLog.status]
-        const errorMessage = `    - **Error**: ${get(
-          subTaskLog.result,
-          'message'
-        )}`
+        const type = subTaskLog.data?.type
+        const errorMarkdown = getErrorMarkdown(subTaskLog)
 
         if (subTaskLog.message === 'snapshot') {
-          snapshotText.push(
-            `- **Snapshot** ${icon}`,
-            ...getTemporalDataMarkdown(subTaskLog.start, subTaskLog.end, 1)
-          )
-        } else if (subTaskLog.data.type === 'remote') {
+          snapshotText.push(`- **Snapshot** ${icon}`, [
+            ...getTemporalDataMarkdown(
+              subTaskLog.end,
+              subTaskLog.start,
+              formatDate
+            ),
+          ])
+        } else if (type === 'remote') {
           const id = subTaskLog.data.id
-          const remote = await xo.getRemote(id).catch(() => {})
-          remotesText.push(
-            `  - **${
-              remote !== undefined ? remote.name : `Remote Not found`
-            }** (${id}) ${icon}`,
-            ...getTemporalDataMarkdown(subTaskLog.start, subTaskLog.end, 2)
-          )
-          addWarnings(remotesText, subTaskLog.warnings, 2)
+          const remote = await xo.getRemote(id).catch(error => {
+            logger.warn(error)
+          })
+          const title = remote !== undefined ? remote.name : `Remote Not found`
+
+          remotesText.push(`- **${title}** (${id}) ${icon}`, [
+            ...getTemporalDataMarkdown(
+              subTaskLog.end,
+              subTaskLog.start,
+              formatDate
+            ),
+            ...getWarningsMarkdown(subTaskLog.warnings),
+            errorMarkdown,
+          ])
+
           if (subTaskLog.status === 'failure') {
             failedSubTasks.push(remote !== undefined ? remote.name : id)
-            remotesText.push('', errorMessage)
           }
         } else {
           const id = subTaskLog.data.id
@@ -294,14 +477,17 @@ class BackupReportsXoPlugin {
           } catch (e) {}
           const [srName, srUuid] =
             sr !== undefined ? [sr.name_label, sr.uuid] : [`SR Not found`, id]
-          srsText.push(
-            `  - **${srName}** (${srUuid}) ${icon}`,
-            ...getTemporalDataMarkdown(subTaskLog.start, subTaskLog.end, 2)
-          )
-          addWarnings(srsText, subTaskLog.warnings, 2)
+          srsText.push(`- **${srName}** (${srUuid}) ${icon}`, [
+            ...getTemporalDataMarkdown(
+              subTaskLog.end,
+              subTaskLog.start,
+              formatDate
+            ),
+            ...getWarningsMarkdown(subTaskLog.warnings),
+            errorMarkdown,
+          ])
           if (subTaskLog.status === 'failure') {
             failedSubTasks.push(sr !== undefined ? sr.name_label : id)
-            srsText.push('', errorMessage)
           }
         }
 
@@ -313,53 +499,48 @@ class BackupReportsXoPlugin {
             return
           }
 
-          const operationInfoText = []
-          addWarnings(operationInfoText, operationLog.warnings, 3)
-          if (operationLog.status === 'success') {
-            const size = operationLog.result.size
+          const size = operationLog.result?.size
+          if (size > 0) {
             if (operationLog.message === 'merge') {
               globalMergeSize += size
             } else {
               globalTransferSize += size
             }
+          }
 
-            operationInfoText.push(
-              `      - **Size**: ${formatSize(size)}`,
-              `      - **Speed**: ${formatSpeed(
-                size,
-                operationLog.end - operationLog.start
-              )}`
-            )
-          } else if (get(operationLog.result, 'message') !== undefined) {
-            operationInfoText.push(
-              `      - **Error**: ${get(operationLog.result, 'message')}`
-            )
-          }
           const operationText = [
-            `    - **${operationLog.message}** ${
-              STATUS_ICON[operationLog.status]
-            }`,
-            ...getTemporalDataMarkdown(operationLog.start, operationLog.end, 3),
-            ...operationInfoText,
-          ].join('\n')
-          if (get(subTaskLog, 'data.type') === 'remote') {
+            `- **${operationLog.message}** ${STATUS_ICON[operationLog.status]}`,
+            [
+              ...getTemporalDataMarkdown(
+                operationLog.end,
+                operationLog.start,
+                formatDate
+              ),
+              size > 0 && `- **Size**: ${formatSize(size)}`,
+              size > 0 &&
+                `- **Speed**: ${formatSpeed(
+                  size,
+                  operationLog.end - operationLog.start
+                )}`,
+              ...getWarningsMarkdown(operationLog.warnings),
+              getErrorMarkdown(operationLog),
+            ],
+          ]
+          if (type === 'remote') {
             remotesText.push(operationText)
-            remotesText.join('\n')
-          }
-          if (get(subTaskLog, 'data.type') === 'SR') {
+          } else if (type === 'SR') {
             srsText.push(operationText)
-            srsText.join('\n')
           }
         })
       }
 
-      if (srsText.length !== 0) {
-        srsText.unshift(`- **SRs**`)
-      }
-      if (remotesText.length !== 0) {
-        remotesText.unshift(`- **Remotes**`)
-      }
-      const subText = [...snapshotText, '', ...srsText, '', ...remotesText]
+      const subText = [
+        ...snapshotText,
+        srsText.length !== 0 && `- **SRs**`,
+        srsText,
+        remotesText.length !== 0 && `- **Remotes**`,
+        remotesText,
+      ]
       if (taskLog.result !== undefined) {
         if (taskLog.status === 'skipped') {
           ++nSkipped
@@ -369,8 +550,7 @@ class BackupReportsXoPlugin {
               taskLog.result.message === UNHEALTHY_VDI_CHAIN_ERROR
                 ? UNHEALTHY_VDI_CHAIN_MESSAGE
                 : taskLog.result.message
-            }`,
-            ''
+            }`
           )
           nagiosText.push(
             `[(Skipped) ${vm !== undefined ? vm.name_label : 'undefined'} : ${
@@ -379,11 +559,7 @@ class BackupReportsXoPlugin {
           )
         } else {
           ++nFailures
-          failedVmsText.push(
-            ...text,
-            `- **Error**: ${taskLog.result.message}`,
-            ''
-          )
+          failedVmsText.push(...text, `- **Error**: ${taskLog.result.message}`)
 
           nagiosText.push(
             `[(Failed) ${vm !== undefined ? vm.name_label : 'undefined'} : ${
@@ -394,7 +570,7 @@ class BackupReportsXoPlugin {
       } else {
         if (taskLog.status === 'failure') {
           ++nFailures
-          failedVmsText.push(...text, '', '', ...subText, '')
+          failedVmsText.push(...text, ...subText)
           nagiosText.push(
             `[${
               vm !== undefined ? vm.name_label : 'undefined'
@@ -402,37 +578,34 @@ class BackupReportsXoPlugin {
           )
         } else if (taskLog.status === 'interrupted') {
           ++nInterrupted
-          interruptedVmsText.push(...text, '', '', ...subText, '')
+          interruptedVmsText.push(...text, ...subText)
           nagiosText.push(
             `[(Interrupted) ${vm !== undefined ? vm.name_label : 'undefined'}]`
           )
         } else {
-          successfulVmsText.push(...text, '', '', ...subText, '')
+          successfulVmsText.push(...text, ...subText)
         }
       }
     }
 
     const nVms = log.tasks.length
     const nSuccesses = nVms - nFailures - nSkipped - nInterrupted
-    let markdown = [
+    const markdown = [
       `##  Global status: ${log.status}`,
       '',
       `- **Job ID**: ${log.jobId}`,
-      `- **Run ID**: ${runJobId}`,
+      `- **Run ID**: ${log.id}`,
       `- **mode**: ${mode}`,
-      ...getTemporalDataMarkdown(log.start, log.end),
+      ...getTemporalDataMarkdown(log.end, log.start, formatDate),
       `- **Successes**: ${nSuccesses} / ${nVms}`,
+      globalTransferSize !== 0 &&
+        `- **Transfer size**: ${formatSize(globalTransferSize)}`,
+      globalMergeSize !== 0 &&
+        `- **Merge size**: ${formatSize(globalMergeSize)}`,
+      ...getWarningsMarkdown(log.warnings),
+      '',
     ]
 
-    if (globalTransferSize !== 0) {
-      markdown.push(`- **Transfer size**: ${formatSize(globalTransferSize)}`)
-    }
-    if (globalMergeSize !== 0) {
-      markdown.push(`- **Merge size**: ${formatSize(globalMergeSize)}`)
-    }
-    addWarnings(markdown, log.warnings)
-    markdown.push('')
-
     if (nFailures !== 0) {
       markdown.push(
         '---',
@@ -457,7 +630,7 @@ class BackupReportsXoPlugin {
       )
     }
 
-    if (nSuccesses !== 0 && reportWhen !== 'failure') {
+    if (nSuccesses !== 0 && (force || reportWhen !== 'failure')) {
       markdown.push(
         '---',
         '',
@@ -468,9 +641,8 @@ class BackupReportsXoPlugin {
     }
 
     markdown.push('---', '', `*${pkg.name} v${pkg.version}*`)
-    markdown = markdown.join('\n')
     return this._sendReport({
-      markdown,
+      markdown: toMarkdown(markdown),
       subject: `[Xen Orchestra] ${log.status} − Backup report for ${jobName} ${
         STATUS_ICON[log.status]
       }`,
@@ -510,9 +682,9 @@ class BackupReportsXoPlugin {
     ])
   }
 
-  _listener(status) {
+  _legacyVmHandler(status) {
     const { calls, timezone, error } = status
-    const formatDate = createDateFormater(timezone)
+    const formatDate = createDateFormatter(timezone)
 
     if (status.error !== undefined) {
       const [globalStatus, icon] =
@@ -537,9 +709,7 @@ class BackupReportsXoPlugin {
         subject: `[Xen Orchestra] ${globalStatus} ${icon}`,
         markdown,
         nagiosStatus: 2,
-        nagiosMarkdown: `[Xen Orchestra] [${globalStatus}] Error : ${
-          error.message
-        }`,
+        nagiosMarkdown: `[Xen Orchestra] [${globalStatus}] Error : ${error.message}`,
       })
     }
 

packages/xo-server-cloud/package.json

@@ -33,14 +33,14 @@
   },
   "dependencies": {
     "http-request-plus": "^0.8.0",
-    "jsonrpc-websocket-client": "^0.4.1"
+    "jsonrpc-websocket-client": "^0.5.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
     "@babel/core": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.5.4"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -49,5 +49,6 @@
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-load-balancer/package.json

@@ -31,7 +31,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@xen-orchestra/cron": "^1.0.3",
+    "@xen-orchestra/cron": "^1.0.4",
     "lodash": "^4.16.2"
   },
   "devDependencies": {
@@ -44,5 +44,6 @@
     "build": "NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
     "dev": "NODE_DEV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-load-balancer/src/density-plan.js

@@ -189,9 +189,7 @@ export default class DensityPlan extends Plan {
         const { vm, destination } = move
         const xapiDest = this.xo.getXapi(destination)
         debug(
-          `Migrate VM (${vm.id}) to Host (${destination.id}) from Host (${
-            vm.$container
-          }).`
+          `Migrate VM (${vm.id}) to Host (${destination.id}) from Host (${vm.$container}).`
         )
         return xapiDest.migrateVm(
           vm._xapiId,

packages/xo-server-load-balancer/src/performance-plan.js

@@ -126,9 +126,7 @@ export default class PerformancePlan extends Plan {
       destinationAverages.memoryFree -= vmAverages.memory
 
       debug(
-        `Migrate VM (${vm.id}) to Host (${destination.id}) from Host (${
-          exceededHost.id
-        }).`
+        `Migrate VM (${vm.id}) to Host (${destination.id}) from Host (${exceededHost.id}).`
       )
       optimizationsCount++
 
@@ -143,9 +141,7 @@ export default class PerformancePlan extends Plan {
 
     await Promise.all(promises)
     debug(
-      `Performance mode: ${optimizationsCount} optimizations for Host (${
-        exceededHost.id
-      }).`
+      `Performance mode: ${optimizationsCount} optimizations for Host (${exceededHost.id}).`
     )
   }
 }

packages/xo-server-perf-alert/package.json

@@ -21,7 +21,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@xen-orchestra/cron": "^1.0.3",
+    "@xen-orchestra/cron": "^1.0.4",
     "d3-time-format": "^2.1.1",
     "json5": "^2.0.1",
     "lodash": "^4.17.4"
@@ -33,7 +33,7 @@
     "@babel/preset-flow": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -42,5 +42,6 @@
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
     "prepublishOnly": "yarn run build"
-  }
+  },
+  "private": true
 }

packages/xo-server-perf-alert/src/index.js

@@ -183,9 +183,7 @@ export const configurationSchema = {
             description: Object.keys(HOST_FUNCTIONS)
               .map(
                 k =>
-                  `  * ${k} (${HOST_FUNCTIONS[k].unit}): ${
-                    HOST_FUNCTIONS[k].description
-                  }`
+                  `  * ${k} (${HOST_FUNCTIONS[k].unit}): ${HOST_FUNCTIONS[k].description}`
               )
               .join('\n'),
             type: 'string',
@@ -233,9 +231,7 @@ export const configurationSchema = {
             description: Object.keys(VM_FUNCTIONS)
               .map(
                 k =>
-                  `  * ${k} (${VM_FUNCTIONS[k].unit}): ${
-                    VM_FUNCTIONS[k].description
-                  }`
+                  `  * ${k} (${VM_FUNCTIONS[k].unit}): ${VM_FUNCTIONS[k].description}`
               )
               .join('\n'),
             type: 'string',
@@ -284,9 +280,7 @@ export const configurationSchema = {
             description: Object.keys(SR_FUNCTIONS)
               .map(
                 k =>
-                  `  * ${k} (${SR_FUNCTIONS[k].unit}): ${
-                    SR_FUNCTIONS[k].description
-                  }`
+                  `  * ${k} (${SR_FUNCTIONS[k].unit}): ${SR_FUNCTIONS[k].description}`
               )
               .join('\n'),
             type: 'string',
@@ -414,9 +408,7 @@ ${monitorBodies.join('\n')}`
   }
 
   _parseDefinition(definition) {
-    const alarmId = `${definition.objectType}|${definition.variableName}|${
-      definition.alarmTriggerLevel
-    }`
+    const alarmId = `${definition.objectType}|${definition.variableName}|${definition.alarmTriggerLevel}`
     const typeFunction =
       TYPE_FUNCTION_MAP[definition.objectType][definition.variableName]
     const parseData = (result, uuid) => {
@@ -468,9 +460,7 @@ ${monitorBodies.join('\n')}`
       ...definition,
       alarmId,
       vmFunction: typeFunction,
-      title: `${typeFunction.name} ${definition.comparator} ${
-        definition.alarmTriggerLevel
-      }${typeFunction.unit}`,
+      title: `${typeFunction.name} ${definition.comparator} ${definition.alarmTriggerLevel}${typeFunction.unit}`,
       snapshot: async () => {
         return Promise.all(
           map(definition.uuids, async uuid => {
@@ -664,9 +654,7 @@ ${entry.listItem}
         subject: `[Xen Orchestra] − Performance Alert ${subjectSuffix}`,
         markdown:
           markdownBody +
-          `\n\n\nSent from Xen Orchestra [perf-alert plugin](${
-            this._configuration.baseUrl
-          }#/settings/plugins)\n`,
+          `\n\n\nSent from Xen Orchestra [perf-alert plugin](${this._configuration.baseUrl}#/settings/plugins)\n`,
       })
     } else {
       throw new Error('The email alert system has a configuration issue.')

packages/xo-server-sdn-controller/.babelrc.js

@@ -0,0 +1,3 @@
+module.exports = require('../../@xen-orchestra/babel-config')(
+  require('./package.json')
+)

packages/xo-server-sdn-controller/README.md

@@ -0,0 +1,26 @@
+# xo-server-sdn-controller [![Build Status](https://travis-ci.org/vatesfr/xen-orchestra.png?branch=master)](https://travis-ci.org/vatesfr/xen-orchestra)
+
+XO Server plugin that allows the creation of pool-wide and cross-pool private networks.
+
+## Install
+
+For installing XO and the plugins from the sources, please take a look at [the documentation](https://xen-orchestra.com/docs/from_the_sources.html).
+
+## Documentation
+
+Please see the plugin's [official documentation](https://xen-orchestra.com/docs/sdn_controller.html).
+
+## Contributions
+
+Contributions are *very* welcomed, either on the documentation or on
+the code.
+
+You may:
+
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
+  you've encountered;
+- fork and create a pull request.
+
+## License
+
+AGPL3 © [Vates SAS](http://vates.fr)

packages/xo-server-sdn-controller/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "xo-server-sdn-controller",
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-server-sdn-controller",
+  "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
+  "repository": {
+    "directory": "packages/xo-server-sdn-controller",
+    "type": "git",
+    "url": "https://github.com/vatesfr/xen-orchestra.git"
+  },
+  "main": "./dist",
+  "scripts": {
+    "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
+    "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
+    "prebuild": "rimraf dist/",
+    "predev": "yarn run prebuild",
+    "prepublishOnly": "yarn run build"
+  },
+  "version": "0.3.0",
+  "engines": {
+    "node": ">=6"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.4.4",
+    "@babel/core": "^7.4.4",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.4.4",
+    "@babel/plugin-proposal-optional-chaining": "^7.2.0",
+    "@babel/preset-env": "^7.4.4",
+    "cross-env": "^5.2.0"
+  },
+  "dependencies": {
+    "@xen-orchestra/log": "^0.1.4",
+    "lodash": "^4.17.11",
+    "node-openssl-cert": "^0.0.97",
+    "promise-toolbox": "^0.13.0",
+    "uuid": "^3.3.2"
+  },
+  "private": true
+}

packages/xo-server-sdn-controller/src/ovsdb-client.js

@@ -0,0 +1,568 @@
+import assert from 'assert'
+import createLogger from '@xen-orchestra/log'
+import fromEvent from 'promise-toolbox/fromEvent'
+import { connect } from 'tls'
+import { forOwn, toPairs } from 'lodash'
+
+const log = createLogger('xo:xo-server:sdn-controller:ovsdb-client')
+
+const OVSDB_PORT = 6640
+
+// =============================================================================
+
+function toMap(object) {
+  return ['map', toPairs(object)]
+}
+
+// =============================================================================
+
+export class OvsdbClient {
+  /*
+  Create an SSL connection to an XCP-ng host.
+  Interact with the host's OpenVSwitch (OVS) daemon to create and manage the virtual bridges
+  corresponding to the private networks with OVSDB (OpenVSwitch DataBase) Protocol.
+  See:
+  - OVSDB Protocol: https://tools.ietf.org/html/rfc7047
+  - OVS Tunneling : http://docs.openvswitch.org/en/latest/howto/tunneling/
+  - OVS IPSEC     : http://docs.openvswitch.org/en/latest/howto/ipsec/
+
+  Attributes on created OVS ports (corresponds to a XAPI `PIF` or `VIF`):
+  - `other_config`:
+    - `xo:sdn-controller:cross-pool`       : UUID of the remote network connected by the tunnel
+    - `xo:sdn-controller:private-pool-wide`: `true` if created (and managed) by a SDN Controller
+
+  Attributes on created OVS interfaces:
+  - `options`:
+    - `key`      : Network's VNI
+    - `remote_ip`: Remote IP of the tunnel
+  */
+
+  constructor(host, clientKey, clientCert, caCert) {
+    this._numberOfPortAndInterface = 0
+    this._requestId = 0
+
+    this._adding = []
+
+    this.host = host
+
+    this.updateCertificates(clientKey, clientCert, caCert)
+
+    log.debug('New OVSDB client', {
+      host: this.host.name_label,
+    })
+  }
+
+  // ---------------------------------------------------------------------------
+
+  updateCertificates(clientKey, clientCert, caCert) {
+    this._clientKey = clientKey
+    this._clientCert = clientCert
+    this._caCert = caCert
+
+    log.debug('Certificates have been updated', {
+      host: this.host.name_label,
+    })
+  }
+
+  // ---------------------------------------------------------------------------
+
+  async addInterfaceAndPort(
+    networkUuid,
+    networkName,
+    remoteAddress,
+    encapsulation,
+    key,
+    password,
+    remoteNetwork
+  ) {
+    if (
+      this._adding.find(
+        elem => elem.id === networkUuid && elem.addr === remoteAddress
+      ) !== undefined
+    ) {
+      return
+    }
+    const adding = { id: networkUuid, addr: remoteAddress }
+    this._adding.push(adding)
+
+    const socket = await this._connect()
+    const [bridgeUuid, bridgeName] = await this._getBridgeUuidForNetwork(
+      networkUuid,
+      networkName,
+      socket
+    )
+    if (bridgeUuid === undefined) {
+      socket.destroy()
+      this._adding = this._adding.filter(
+        elem => elem.id !== networkUuid || elem.addr !== remoteAddress
+      )
+      return
+    }
+
+    const alreadyExist = await this._interfaceAndPortAlreadyExist(
+      bridgeUuid,
+      bridgeName,
+      remoteAddress,
+      socket
+    )
+    if (alreadyExist) {
+      socket.destroy()
+      this._adding = this._adding.filter(
+        elem => elem.id !== networkUuid || elem.addr !== remoteAddress
+      )
+      return bridgeName
+    }
+
+    const index = ++this._numberOfPortAndInterface
+    const interfaceName = bridgeName + '_iface' + index
+    const portName = bridgeName + '_port' + index
+
+    // Add interface and port to the bridge
+    const options = { remote_ip: remoteAddress, key: key }
+    if (password !== undefined) {
+      options.psk = password
+    }
+    const addInterfaceOperation = {
+      op: 'insert',
+      table: 'Interface',
+      row: {
+        type: encapsulation,
+        options: toMap(options),
+        name: interfaceName,
+      },
+      'uuid-name': 'new_iface',
+    }
+
+    const addPortOperation = {
+      op: 'insert',
+      table: 'Port',
+      row: {
+        name: portName,
+        interfaces: ['set', [['named-uuid', 'new_iface']]],
+        other_config: toMap(
+          remoteNetwork !== undefined
+            ? { 'xo:sdn-controller:cross-pool': remoteNetwork }
+            : { 'xo:sdn-controller:private-pool-wide': 'true' }
+        ),
+      },
+      'uuid-name': 'new_port',
+    }
+
+    const mutateBridgeOperation = {
+      op: 'mutate',
+      table: 'Bridge',
+      where: [['_uuid', '==', ['uuid', bridgeUuid]]],
+      mutations: [['ports', 'insert', ['set', [['named-uuid', 'new_port']]]]],
+    }
+    const params = [
+      'Open_vSwitch',
+      addInterfaceOperation,
+      addPortOperation,
+      mutateBridgeOperation,
+    ]
+    const jsonObjects = await this._sendOvsdbTransaction(params, socket)
+
+    this._adding = this._adding.filter(
+      elem => elem.id !== networkUuid || elem.addr !== remoteAddress
+    )
+    if (jsonObjects === undefined) {
+      socket.destroy()
+      return
+    }
+
+    let error
+    let details
+    let i = 0
+    let opResult
+    do {
+      opResult = jsonObjects[0].result[i]
+      if (opResult?.error !== undefined) {
+        error = opResult.error
+        details = opResult.details
+      }
+      ++i
+    } while (opResult !== undefined && error === undefined)
+
+    if (error !== undefined) {
+      log.error('Error while adding port and interface to bridge', {
+        error,
+        details,
+        port: portName,
+        interface: interfaceName,
+        bridge: bridgeName,
+        network: networkName,
+        host: this.host.name_label,
+      })
+      socket.destroy()
+      return
+    }
+
+    log.debug('Port and interface added to bridge', {
+      port: portName,
+      interface: interfaceName,
+      bridge: bridgeName,
+      network: networkName,
+      host: this.host.name_label,
+    })
+    socket.destroy()
+    return bridgeName
+  }
+
+  async resetForNetwork(
+    networkUuid,
+    networkName,
+    crossPoolOnly,
+    remoteNetwork
+  ) {
+    const socket = await this._connect()
+    const [bridgeUuid, bridgeName] = await this._getBridgeUuidForNetwork(
+      networkUuid,
+      networkName,
+      socket
+    )
+    if (bridgeUuid === undefined) {
+      socket.destroy()
+      return
+    }
+
+    // Delete old ports created by a SDN controller
+    const ports = await this._getBridgePorts(bridgeUuid, bridgeName, socket)
+    if (ports === undefined) {
+      socket.destroy()
+      return
+    }
+    const portsToDelete = []
+    for (const port of ports) {
+      const portUuid = port[1]
+
+      const where = [['_uuid', '==', ['uuid', portUuid]]]
+      const selectResult = await this._select(
+        'Port',
+        ['name', 'other_config'],
+        where,
+        socket
+      )
+      if (selectResult === undefined) {
+        continue
+      }
+
+      forOwn(selectResult.other_config[1], config => {
+        // 2019-09-03
+        // Compatibility code, to be removed in 1 year.
+        const oldShouldDelete =
+          (config[0] === 'private_pool_wide' && !crossPoolOnly) ||
+          (config[0] === 'cross_pool' &&
+            (remoteNetwork === undefined || remoteNetwork === config[1]))
+
+        const shouldDelete =
+          (config[0] === 'xo:sdn-controller:private-pool-wide' &&
+            !crossPoolOnly) ||
+          (config[0] === 'xo:sdn-controller:cross-pool' &&
+            (remoteNetwork === undefined || remoteNetwork === config[1]))
+
+        if (shouldDelete || oldShouldDelete) {
+          portsToDelete.push(['uuid', portUuid])
+        }
+      })
+    }
+
+    if (portsToDelete.length === 0) {
+      // Nothing to do
+      socket.destroy()
+      return
+    }
+
+    const mutateBridgeOperation = {
+      op: 'mutate',
+      table: 'Bridge',
+      where: [['_uuid', '==', ['uuid', bridgeUuid]]],
+      mutations: [['ports', 'delete', ['set', portsToDelete]]],
+    }
+
+    const params = ['Open_vSwitch', mutateBridgeOperation]
+    const jsonObjects = await this._sendOvsdbTransaction(params, socket)
+    if (jsonObjects === undefined) {
+      socket.destroy()
+      return
+    }
+    if (jsonObjects[0].error != null) {
+      log.error('Error while deleting ports from bridge', {
+        error: jsonObjects[0].error,
+        bridge: bridgeName,
+        host: this.host.name_label,
+      })
+      socket.destroy()
+      return
+    }
+
+    log.debug('Ports deleted from bridge', {
+      nPorts: jsonObjects[0].result[0].count,
+      bridge: bridgeName,
+      host: this.host.name_label,
+    })
+    socket.destroy()
+  }
+
+  // ===========================================================================
+
+  _parseJson(chunk) {
+    let data = chunk.toString()
+    let buffer = ''
+    let depth = 0
+    let pos = 0
+    const objects = []
+
+    for (let i = pos; i < data.length; ++i) {
+      const c = data.charAt(i)
+      if (c === '{') {
+        ++depth
+      } else if (c === '}') {
+        --depth
+        if (depth === 0) {
+          const object = JSON.parse(buffer + data.substr(0, i + 1))
+          objects.push(object)
+          buffer = ''
+          data = data.substr(i + 1)
+          pos = 0
+          i = -1
+        }
+      }
+    }
+
+    buffer += data
+    return objects
+  }
+
+  // ---------------------------------------------------------------------------
+
+  async _getBridgeUuidForNetwork(networkUuid, networkName, socket) {
+    const where = [
+      ['external_ids', 'includes', toMap({ 'xs-network-uuids': networkUuid })],
+    ]
+    const selectResult = await this._select(
+      'Bridge',
+      ['_uuid', 'name'],
+      where,
+      socket
+    )
+    if (selectResult === undefined) {
+      log.error('No bridge found for network', {
+        network: networkName,
+        host: this.host.name_label,
+      })
+      return []
+    }
+
+    const bridgeUuid = selectResult._uuid[1]
+    const bridgeName = selectResult.name
+
+    return [bridgeUuid, bridgeName]
+  }
+
+  async _interfaceAndPortAlreadyExist(
+    bridgeUuid,
+    bridgeName,
+    remoteAddress,
+    socket
+  ) {
+    const ports = await this._getBridgePorts(bridgeUuid, bridgeName, socket)
+    if (ports === undefined) {
+      return false
+    }
+
+    for (const port of ports) {
+      const portUuid = port[1]
+      const interfaces = await this._getPortInterfaces(portUuid, socket)
+      if (interfaces === undefined) {
+        continue
+      }
+
+      for (const iface of interfaces) {
+        const interfaceUuid = iface[1]
+        const hasRemote = await this._interfaceHasRemote(
+          interfaceUuid,
+          remoteAddress,
+          socket
+        )
+        if (hasRemote) {
+          return true
+        }
+      }
+    }
+
+    return false
+  }
+
+  async _getBridgePorts(bridgeUuid, bridgeName, socket) {
+    const where = [['_uuid', '==', ['uuid', bridgeUuid]]]
+    const selectResult = await this._select('Bridge', ['ports'], where, socket)
+    if (selectResult === undefined) {
+      return
+    }
+
+    return selectResult.ports[0] === 'set'
+      ? selectResult.ports[1]
+      : [selectResult.ports]
+  }
+
+  async _getPortInterfaces(portUuid, socket) {
+    const where = [['_uuid', '==', ['uuid', portUuid]]]
+    const selectResult = await this._select(
+      'Port',
+      ['name', 'interfaces'],
+      where,
+      socket
+    )
+    if (selectResult === undefined) {
+      return
+    }
+
+    return selectResult.interfaces[0] === 'set'
+      ? selectResult.interfaces[1]
+      : [selectResult.interfaces]
+  }
+
+  async _interfaceHasRemote(interfaceUuid, remoteAddress, socket) {
+    const where = [['_uuid', '==', ['uuid', interfaceUuid]]]
+    const selectResult = await this._select(
+      'Interface',
+      ['name', 'options'],
+      where,
+      socket
+    )
+    if (selectResult === undefined) {
+      return false
+    }
+
+    for (const option of selectResult.options[1]) {
+      if (option[0] === 'remote_ip' && option[1] === remoteAddress) {
+        return true
+      }
+    }
+
+    return false
+  }
+
+  // ---------------------------------------------------------------------------
+
+  async _select(table, columns, where, socket) {
+    const selectOperation = {
+      op: 'select',
+      table: table,
+      columns: columns,
+      where: where,
+    }
+
+    const params = ['Open_vSwitch', selectOperation]
+    const jsonObjects = await this._sendOvsdbTransaction(params, socket)
+    if (jsonObjects === undefined) {
+      return
+    }
+    const jsonResult = jsonObjects[0].result[0]
+    if (jsonResult.error !== undefined) {
+      log.error('Error while selecting columns', {
+        error: jsonResult.error,
+        details: jsonResult.details,
+        columns,
+        table,
+        where,
+        host: this.host.name_label,
+      })
+      return
+    }
+
+    if (jsonResult.rows.length === 0) {
+      log.error('No result for select', {
+        columns,
+        table,
+        where,
+        host: this.host.name_label,
+      })
+      return
+    }
+
+    // For now all select operations should return only 1 row
+    assert(
+      jsonResult.rows.length === 1,
+      `[${this.host.name_label}] There should be exactly 1 row when searching: '${columns}' in: '${table}' where: '${where}'`
+    )
+
+    return jsonResult.rows[0]
+  }
+
+  async _sendOvsdbTransaction(params, socket) {
+    const stream = socket
+    const requestId = ++this._requestId
+    const req = {
+      id: requestId,
+      method: 'transact',
+      params: params,
+    }
+
+    try {
+      stream.write(JSON.stringify(req))
+    } catch (error) {
+      log.error('Error while writing into stream', {
+        error,
+        host: this.host.name_label,
+      })
+      return
+    }
+
+    let result
+    let jsonObjects
+    let resultRequestId
+    do {
+      try {
+        result = await fromEvent(stream, 'data', {})
+      } catch (error) {
+        log.error('Error while waiting for stream data', {
+          error,
+          host: this.host.name_label,
+        })
+        return
+      }
+
+      jsonObjects = this._parseJson(result)
+      resultRequestId = jsonObjects[0].id
+    } while (resultRequestId !== requestId)
+
+    return jsonObjects
+  }
+
+  // ---------------------------------------------------------------------------
+
+  async _connect() {
+    const options = {
+      ca: this._caCert,
+      key: this._clientKey,
+      cert: this._clientCert,
+      host: this.host.address,
+      port: OVSDB_PORT,
+      rejectUnauthorized: false,
+      requestCert: false,
+    }
+    const socket = connect(options)
+
+    try {
+      await fromEvent(socket, 'secureConnect', {})
+    } catch (error) {
+      log.error('TLS connection failed', {
+        error,
+        code: error.code,
+        host: this.host.name_label,
+      })
+      throw error
+    }
+
+    socket.on('error', error => {
+      log.error('Socket error', {
+        error,
+        code: error.code,
+        host: this.host.name_label,
+      })
+    })
+
+    return socket
+  }
+}

packages/xo-server-test/.babelrc.js

@@ -0,0 +1,8 @@
+const pkg = require('./package.json')
+
+// `xo-server-test` is a special package which has no dev dependencies but our
+// babel config generator only looks in `devDependencies`.
+require('assert').strictEqual(pkg.devDependencies, undefined)
+pkg.devDependencies = pkg.dependencies
+
+module.exports = require('../../@xen-orchestra/babel-config')(pkg)

packages/xo-server-test/.npmignore

@@ -0,0 +1,24 @@
+/benchmark/
+/benchmarks/
+*.bench.js
+*.bench.js.map
+
+/examples/
+example.js
+example.js.map
+*.example.js
+*.example.js.map
+
+/fixture/
+/fixtures/
+*.fixture.js
+*.fixture.js.map
+*.fixtures.js
+*.fixtures.js.map
+
+/test/
+/tests/
+*.spec.js
+*.spec.js.map
+
+__snapshots__/

packages/xo-server-test/README.md

@@ -0,0 +1,160 @@
+# xo-server-test
+
+> Test client for Xo-Server
+
+Tests are ran sequentially to avoid concurrency issues.
+
+## Adding a test
+
+### Organization
+
+```
+src
+├─ user
+|   ├─ __snapshots__
+|   |     └─ index.spec.js.snap
+|   └─ index.spec.js
+├─ job
+|   └─ index.spec.js
+├─ issues
+¦   └─ index.spec.js
+¦
+├─ _xoConnection.js
+└─ util.js
+```
+
+The tests can describe:
+
+  - XO methods or scenarios:
+
+`src/user/index.js`
+```js
+import xo from "../_xoConnection";
+
+describe("user", () => {
+
+  // testing a method
+  describe(".set()", () => {
+    it("sets an email", async () => {
+      // some tests using xo methods and helpers from _xoConnection.js
+      const id = await xo.createTempUser(SIMPLE_USER);
+      expect(await xo.call("user.set", params)).toBe(true);
+      expect(await xo.getUser(id)).toMatchSnapshot({
+        id: expect.any(String),
+      });
+    });
+  });
+
+  // testing a scenario
+  test("create two users, modify a user email to be the same with the other and fail trying to connect them", () => {
+    /* some tests */
+  });
+
+});
+```
+  - issues
+
+`src/issues/index.js`
+```js
+ describe("issue", () => {
+  test("5454", () => {
+    /* some tests */
+  })
+})
+```
+
+### Best practices
+
+- The test environment must remain the same before and after each test:
+  * each resource created must be deleted
+  * existing resources should not be altered
+
+- Make a sentence for the title of the test. It must be clear and consistent.
+
+- If the feature you want to test is not implemented : write it and skip it, using `it.skip()`.
+
+- Take values ​​that cover the maximum of testing possibilities.
+
+- If you make tests which keep track of large object, it is better to use snapshots.
+
+- `_xoConnection.js` contains helpers to create temporary resources and to interface with XO.
+  You can use it if you need to create resources which will be automatically deleted after the test:
+  ```javascript
+  import xo from "../_xoConnection";
+
+  describe(".create()", () => {
+    it("creates a user without permission", async () => {
+      // The user will be deleted automatically at the end of the test
+      const userId = await xo.createTempUser({
+        email: "wayne1@vates.fr",
+        password: "batman1",
+      });
+      expect(await xo.getUser(userId)).toMatchSnapshot({
+        id: expect.any(String),
+      });
+    });
+  });
+  ```
+
+  The available helpers:
+  * `createTempUser(params)`
+  * `getUser(id)`
+  * `createTempJob(params)`
+  * `createTempBackupNgJob(params)`
+  * `createTempVm(params)`
+  * `getSchedule(predicate)`
+
+## Usage
+
+- Before running the tests, you have to create a config file for xo-server-test.
+  ```
+  > cp sample.config.toml ~/.config/xo-server-test/config.toml
+  ```
+  And complete it.
+
+- To run the tests:
+  ```
+  > npm ci
+  > yarn test
+  ```
+
+  You get all the test suites passed (`PASS`) or failed (`FAIL`).
+  ```
+  > yarn test
+  yarn run v1.9.4
+  $ jest
+   PASS  src/user/user.spec.js
+   PASS  src/job/job.spec.js
+   PASS  src/backupNg/backupNg.spec.js
+
+  Test Suites: 3 passed, 3 total
+  Tests:       2 skipped, 36 passed, 38 total
+  Snapshots:   35 passed, 35 total
+  Time:        7.257s, estimated 8s
+  Ran all test suites.
+  Done in 7.92s.
+  ```
+
+- You can run only tests related to changed files, and review the failed output by using: `> yarn test --watch`
+
+- ⚠ Warning: snapshots ⚠  
+After each run of the tests, check that snapshots are not inadvertently modified.
+
+- ⚠ Jest known issue ⚠  
+If a test timeout is triggered the next async tests can fail, it's due to an inadvertently modified snapshots.
+As a workaround, you can clean your git working tree and re-run jest using a large timeout: `> yarn test --testTimeout=100000`
+
+## Contributions
+
+Contributions are *very* welcomed, either on the documentation or on
+the code.
+
+You may:
+
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
+  you've encountered;
+- fork and create a pull request.
+
+## License
+
+ISC © [Vates SAS](http://vates.fr)

packages/xo-server-test/package.json

@@ -0,0 +1,56 @@
+{
+  "private": true,
+  "name": "xo-server-test",
+  "version": "0.0.0",
+  "license": "ISC",
+  "description": "Test client for Xo-Server",
+  "keywords": [],
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-server-test",
+  "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
+  "repository": {
+    "directory": "packages/xo-server-test",
+    "type": "git",
+    "url": "https://github.com/vatesfr/xen-orchestra.git"
+  },
+  "author": {
+    "name": "Julien Fontanet",
+    "email": "julien.fontanet@isonoe.net"
+  },
+  "preferGlobal": false,
+  "main": "dist/",
+  "bin": {},
+  "files": [
+    "dist/"
+  ],
+  "engines": {
+    "node": ">=6"
+  },
+  "dependencies": {
+    "@babel/cli": "^7.1.5",
+    "@babel/core": "^7.1.6",
+    "@babel/plugin-proposal-decorators": "^7.4.0",
+    "@babel/preset-env": "^7.1.6",
+    "@iarna/toml": "^2.2.1",
+    "app-conf": "^0.7.0",
+    "babel-plugin-lodash": "^3.2.11",
+    "golike-defer": "^0.4.1",
+    "jest": "^24.8.0",
+    "lodash": "^4.17.11",
+    "promise-toolbox": "^0.13.0",
+    "xo-collection": "^0.4.1",
+    "xo-common": "^0.2.0",
+    "xo-lib": "^0.9.0"
+  },
+  "scripts": {
+    "dev-test": "jest --bail --watch",
+    "test": "jest"
+  },
+  "jest": {
+    "modulePathIgnorePatterns": [
+      "<rootDir>/src/old-tests"
+    ],
+    "testEnvironment": "node",
+    "testRegex": "\\.spec\\.js$",
+    "maxConcurrency": 1
+  }
+}

packages/xo-server-test/sample.config.toml

@@ -0,0 +1,29 @@
+[xoConnection]
+  url = ''
+  email = ''
+  password = ''
+
+[pools]
+  default = ''
+
+[servers]
+  [servers.default]
+    username = ''
+    password = ''
+    host = ''
+
+[vms]
+  default = ''
+  # vmToBackup = ''
+
+[templates]
+  default = ''
+  templateWithoutDisks = ''
+
+[srs]
+  default = ''
+
+[remotes]
+  default = { name = '', url = '' }
+  remote1 = { name = '', url = '' }
+  # remote2 = { name = '', url = '' }

packages/xo-server-test/src/_config.js

@@ -0,0 +1,13 @@
+import appConf from 'app-conf'
+import path from 'path'
+
+/* eslint-env jest */
+
+let config
+export { config as default }
+
+beforeAll(async () => {
+  config = await appConf.load('xo-server-test', {
+    appDir: path.join(__dirname, '..'),
+  })
+})

packages/xo-server-test/src/_randomId.js

@@ -0,0 +1,6 @@
+const randomId = () =>
+  Math.random()
+    .toString(36)
+    .slice(2)
+
+export { randomId as default }

packages/xo-server-test/src/_xoConnection.js

@@ -0,0 +1,261 @@
+/* eslint-env jest */
+import defer from 'golike-defer'
+import Xo from 'xo-lib'
+import XoCollection from 'xo-collection'
+import { find, forOwn } from 'lodash'
+import { fromEvent } from 'promise-toolbox'
+
+import config from './_config'
+
+const getDefaultCredentials = () => {
+  const { email, password } = config.xoConnection
+  return { email, password }
+}
+
+class XoConnection extends Xo {
+  constructor(opts) {
+    super(opts)
+
+    const objects = (this._objects = new XoCollection())
+    const watchers = (this._watchers = {})
+    this._tempResourceDisposers = []
+    this._durableResourceDisposers = []
+
+    this.on('notification', ({ method, params }) => {
+      if (method !== 'all') {
+        return
+      }
+
+      const fn = params.type === 'exit' ? objects.unset : objects.set
+      forOwn(params.items, (item, id) => {
+        fn.call(objects, id, item)
+
+        const watcher = watchers[id]
+        if (watcher !== undefined) {
+          watcher(item)
+          delete watchers[id]
+        }
+      })
+    })
+  }
+
+  get objects() {
+    return this._objects
+  }
+
+  async _fetchObjects() {
+    const { _objects: objects, _watchers: watchers } = this
+    forOwn(await this.call('xo.getAllObjects'), (object, id) => {
+      objects.set(id, object)
+
+      const watcher = watchers[id]
+      if (watcher !== undefined) {
+        watcher(object)
+        delete watchers[id]
+      }
+    })
+  }
+
+  // TODO: integrate in xo-lib.
+  waitObject(id) {
+    return new Promise(resolve => {
+      this._watchers[id] = resolve
+    }) // FIXME: work with multiple listeners.
+  }
+
+  async getOrWaitObject(id) {
+    const object = this._objects.all[id]
+    if (object !== undefined) {
+      return object
+    }
+    return this.waitObject(id)
+  }
+
+  @defer
+  async connect($defer, credentials = getDefaultCredentials()) {
+    await this.open()
+    $defer.onFailure(() => this.close())
+
+    await this.signIn(credentials)
+    await this._fetchObjects()
+
+    return this
+  }
+
+  async waitObjectState(id, predicate) {
+    let obj = this._objects.all[id]
+    while (true) {
+      try {
+        await predicate(obj)
+        return obj
+      } catch (_) {}
+      // If failed, wait for next object state/update and retry.
+      obj = await this.waitObject(id)
+    }
+  }
+
+  async createTempUser(params) {
+    const id = await this.call('user.create', params)
+    this._tempResourceDisposers.push('user.delete', { id })
+    return id
+  }
+
+  async getUser(id) {
+    return find(await super.call('user.getAll'), { id })
+  }
+
+  async createTempJob(params) {
+    const id = await this.call('job.create', { job: params })
+    this._tempResourceDisposers.push('job.delete', { id })
+    return id
+  }
+
+  async createTempBackupNgJob(params) {
+    const job = await this.call('backupNg.createJob', params)
+    this._tempResourceDisposers.push('backupNg.deleteJob', { id: job.id })
+    return job
+  }
+
+  async createTempNetwork(params) {
+    const id = await this.call('network.create', {
+      name: 'XO Test',
+      pool: config.pools.default,
+      ...params,
+    })
+    this._tempResourceDisposers.push('network.delete', { id })
+    return this.getOrWaitObject(id)
+  }
+
+  async createTempVm(params) {
+    const id = await this.call('vm.create', {
+      name_label: 'XO Test',
+      template: config.templates.templateWithoutDisks,
+      ...params,
+    })
+    this._tempResourceDisposers.push('vm.delete', { id })
+    return this.waitObjectState(id, vm => {
+      if (vm.type !== 'VM') throw new Error('retry')
+    })
+  }
+
+  async createTempRemote(params) {
+    const remote = await this.call('remote.create', params)
+    this._tempResourceDisposers.push('remote.delete', { id: remote.id })
+    return remote
+  }
+
+  async createTempServer(params) {
+    const servers = await this.call('server.getAll')
+    const server = servers.find(server => server.host === params.host)
+    if (server !== undefined) {
+      if (server.status === 'disconnected') {
+        await this.call('server.enable', { id: server.id })
+        this._durableResourceDisposers.push('server.disable', { id: server.id })
+        await fromEvent(this._objects, 'finish')
+      }
+      return
+    }
+
+    const id = await this.call('server.add', {
+      ...params,
+      allowUnauthorized: true,
+      autoConnect: false,
+    })
+    this._durableResourceDisposers.push('server.remove', { id })
+    await this.call('server.enable', { id })
+    await fromEvent(this._objects, 'finish')
+  }
+
+  async getSchedule(predicate) {
+    return find(await this.call('schedule.getAll'), predicate)
+  }
+
+  async runBackupJob(jobId, scheduleId, { remotes, nExecutions = 1 }) {
+    for (let i = 0; i < nExecutions; i++) {
+      await xo.call('backupNg.runJob', { id: jobId, schedule: scheduleId })
+    }
+    const backups = {}
+    if (remotes !== undefined) {
+      const backupsByRemote = await xo.call('backupNg.listVmBackups', {
+        remotes,
+      })
+      forOwn(backupsByRemote, (backupsByVm, remoteId) => {
+        backups[remoteId] = []
+        forOwn(backupsByVm, vmBackups => {
+          vmBackups.forEach(
+            ({ jobId: backupJobId, scheduleId: backupScheduleId, id }) => {
+              if (jobId === backupJobId && scheduleId === backupScheduleId) {
+                this._tempResourceDisposers.push('backupNg.deleteVmBackup', {
+                  id,
+                })
+                backups[remoteId].push(id)
+              }
+            }
+          )
+        })
+      })
+    }
+
+    forOwn(this.objects.all, (obj, id) => {
+      if (
+        obj.other !== undefined &&
+        obj.other['xo:backup:job'] === jobId &&
+        obj.other['xo:backup:schedule'] === scheduleId
+      ) {
+        this._tempResourceDisposers.push('vm.delete', {
+          id,
+        })
+      }
+    })
+    return backups
+  }
+
+  async _cleanDisposers(disposers) {
+    for (let n = disposers.length - 1; n > 0; ) {
+      const params = disposers[n--]
+      const method = disposers[n--]
+      await this.call(method, params).catch(error => {
+        console.warn('deleteTempResources', method, params, error)
+      })
+    }
+    disposers.length = 0
+  }
+
+  async deleteTempResources() {
+    await this._cleanDisposers(this._tempResourceDisposers)
+  }
+
+  async deleteDurableResources() {
+    await this._cleanDisposers(this._durableResourceDisposers)
+  }
+}
+
+const getConnection = credentials => {
+  const xo = new XoConnection({ url: config.xoConnection.url })
+  return xo.connect(credentials)
+}
+
+let xo
+beforeAll(async () => {
+  // TOFIX: stop tests if the connection is not established properly and show the error
+  xo = await getConnection()
+})
+afterAll(async () => {
+  await xo.deleteDurableResources()
+  await xo.close()
+  xo = null
+})
+afterEach(() => xo.deleteTempResources())
+
+export { xo as default }
+
+export const testConnection = ({ credentials }) =>
+  getConnection(credentials).then(connection => connection.close())
+
+export const testWithOtherConnection = defer(
+  async ($defer, credentials, functionToExecute) => {
+    const xoUser = await getConnection(credentials)
+    $defer(() => xoUser.close())
+    await functionToExecute(xoUser)
+  }
+)

packages/xo-server-test/src/backupNg/__snapshots__/backupNg.spec.js.snap

@@ -0,0 +1,539 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`backupNg .createJob() : creates a new backup job with schedules 1`] = `
+Object {
+  "id": Any<String>,
+  "mode": "full",
+  "name": "default-backupNg",
+  "settings": Any<Object>,
+  "type": "backup",
+  "userId": Any<String>,
+  "vms": Any<Object>,
+}
+`;
+
+exports[`backupNg .createJob() : creates a new backup job with schedules 2`] = `
+Object {
+  "cron": "0 * * * * *",
+  "enabled": false,
+  "id": Any<String>,
+  "jobId": Any<String>,
+  "name": "scheduleTest",
+}
+`;
+
+exports[`backupNg .createJob() : creates a new backup job without schedules 1`] = `
+Object {
+  "id": Any<String>,
+  "mode": "full",
+  "name": "default-backupNg",
+  "settings": Object {
+    "": Object {
+      "reportWhen": "never",
+    },
+  },
+  "type": "backup",
+  "userId": Any<String>,
+  "vms": Any<Object>,
+}
+`;
+
+exports[`backupNg .runJob() : fails trying to run a backup job with a VM without disks 1`] = `
+Object {
+  "data": Object {
+    "mode": "full",
+    "reportWhen": "never",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "jobId": Any<String>,
+  "jobName": "default-backupNg",
+  "message": "backup",
+  "scheduleId": Any<String>,
+  "start": Any<Number>,
+  "status": "skipped",
+}
+`;
+
+exports[`backupNg .runJob() : fails trying to run a backup job with a VM without disks 2`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "type": "VM",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "message": "no disks found",
+    "name": "Error",
+    "stack": Any<String>,
+  },
+  "start": Any<Number>,
+  "status": "skipped",
+}
+`;
+
+exports[`backupNg .runJob() : fails trying to run a backup job with no matching VMs 1`] = `[JsonRpcError: unknown error from the peer]`;
+
+exports[`backupNg .runJob() : fails trying to run a backup job with non-existent vm 1`] = `
+Array [
+  Object {
+    "data": Object {
+      "vms": Array [
+        "non-existent-id",
+      ],
+    },
+    "message": "missingVms",
+  },
+]
+`;
+
+exports[`backupNg .runJob() : fails trying to run a backup job without schedule 1`] = `[JsonRpcError: invalid parameters]`;
+
+exports[`backupNg .runJob() : fails trying to run backup job without retentions 1`] = `
+Object {
+  "data": Object {
+    "mode": "full",
+    "reportWhen": "never",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "jobId": Any<String>,
+  "jobName": "default-backupNg",
+  "message": "backup",
+  "scheduleId": Any<String>,
+  "start": Any<Number>,
+  "status": "failure",
+}
+`;
+
+exports[`backupNg .runJob() : fails trying to run backup job without retentions 2`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "type": "VM",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "message": "copy, export and snapshot retentions cannot both be 0",
+    "name": "Error",
+    "stack": Any<String>,
+  },
+  "start": Any<Number>,
+  "status": "failure",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 1`] = `
+Object {
+  "data": Object {
+    "mode": "delta",
+    "reportWhen": "never",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "jobId": Any<String>,
+  "message": "backup",
+  "scheduleId": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 2`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "type": "VM",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 3`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": "snapshot",
+  "result": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 4`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "isFull": true,
+    "type": "remote",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 5`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 6`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 7`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "isFull": true,
+    "type": "remote",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 8`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 9`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 10`] = `
+Object {
+  "data": Object {
+    "mode": "delta",
+    "reportWhen": "never",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "jobId": Any<String>,
+  "message": "backup",
+  "scheduleId": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 11`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "type": "VM",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 12`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": "snapshot",
+  "result": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 13`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "isFull": false,
+    "type": "remote",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 14`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 15`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 16`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "isFull": false,
+    "type": "remote",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 17`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 18`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 19`] = `
+Object {
+  "data": Object {
+    "mode": "delta",
+    "reportWhen": "never",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "jobId": Any<String>,
+  "message": "backup",
+  "scheduleId": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 20`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "type": "VM",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 21`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": "snapshot",
+  "result": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 22`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "isFull": true,
+    "type": "remote",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 23`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 24`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 25`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "isFull": true,
+    "type": "remote",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 26`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval 27`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "result": Object {
+    "size": Any<Number>,
+  },
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a rolling snapshot with 2 as retention & revert to an old state 1`] = `
+Object {
+  "data": Object {
+    "mode": "full",
+    "reportWhen": "never",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "jobId": Any<String>,
+  "jobName": "default-backupNg",
+  "message": "backup",
+  "scheduleId": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a rolling snapshot with 2 as retention & revert to an old state 2`] = `
+Object {
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": "snapshot",
+  "result": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;
+
+exports[`backupNg execute three times a rolling snapshot with 2 as retention & revert to an old state 3`] = `
+Object {
+  "data": Object {
+    "id": Any<String>,
+    "type": "VM",
+  },
+  "end": Any<Number>,
+  "id": Any<String>,
+  "message": Any<String>,
+  "start": Any<Number>,
+  "status": "success",
+}
+`;

packages/xo-server-test/src/backupNg/backupNg.spec.js

@@ -0,0 +1,588 @@
+/* eslint-env jest */
+
+import { forOwn } from 'lodash'
+import { noSuchObject } from 'xo-common/api-errors'
+
+import config from '../_config'
+import randomId from '../_randomId'
+import xo from '../_xoConnection'
+
+const DEFAULT_SCHEDULE = {
+  name: 'scheduleTest',
+  cron: '0 * * * * *',
+}
+
+const validateRootTask = (log, props) =>
+  expect(log).toMatchSnapshot({
+    end: expect.any(Number),
+    id: expect.any(String),
+    jobId: expect.any(String),
+    scheduleId: expect.any(String),
+    start: expect.any(Number),
+    ...props,
+  })
+
+const validateVmTask = (task, vmId, props) => {
+  expect(task).toMatchSnapshot({
+    data: {
+      id: expect.any(String),
+    },
+    end: expect.any(Number),
+    id: expect.any(String),
+    message: expect.any(String),
+    start: expect.any(Number),
+    ...props,
+  })
+  expect(task.data.id).toBe(vmId)
+}
+
+const validateSnapshotTask = (task, props) =>
+  expect(task).toMatchSnapshot({
+    end: expect.any(Number),
+    id: expect.any(String),
+    result: expect.any(String),
+    start: expect.any(Number),
+    ...props,
+  })
+
+const validateExportTask = (task, srOrRemoteIds, props) => {
+  expect(task).toMatchSnapshot({
+    end: expect.any(Number),
+    id: expect.any(String),
+    message: expect.any(String),
+    start: expect.any(Number),
+    ...props,
+  })
+  expect(srOrRemoteIds).toContain(task.data.id)
+}
+
+const validateOperationTask = (task, props) => {
+  expect(task).toMatchSnapshot({
+    end: expect.any(Number),
+    id: expect.any(String),
+    message: expect.any(String),
+    start: expect.any(Number),
+    ...props,
+  })
+}
+
+// Note: `bypassVdiChainsCheck` must be enabled because the XAPI might be not
+// able to coalesce VDIs as fast as the tests run.
+//
+// See https://xen-orchestra.com/docs/backup_troubleshooting.html#vdi-chain-protection
+describe('backupNg', () => {
+  let defaultBackupNg
+
+  beforeAll(() => {
+    defaultBackupNg = {
+      name: 'default-backupNg',
+      mode: 'full',
+      vms: {
+        id: config.vms.default,
+      },
+      settings: {
+        '': {
+          reportWhen: 'never',
+        },
+      },
+    }
+  })
+
+  describe('.createJob() :', () => {
+    it('creates a new backup job without schedules', async () => {
+      const backupNg = await xo.createTempBackupNgJob(defaultBackupNg)
+      expect(backupNg).toMatchSnapshot({
+        id: expect.any(String),
+        userId: expect.any(String),
+        vms: expect.any(Object),
+      })
+      expect(backupNg.vms).toEqual(defaultBackupNg.vms)
+      expect(backupNg.userId).toBe(xo._user.id)
+    })
+
+    it('creates a new backup job with schedules', async () => {
+      const scheduleTempId = randomId()
+      const { id: jobId } = await xo.createTempBackupNgJob({
+        ...defaultBackupNg,
+        schedules: {
+          [scheduleTempId]: DEFAULT_SCHEDULE,
+        },
+        settings: {
+          ...defaultBackupNg.settings,
+          [scheduleTempId]: { snapshotRetention: 1 },
+        },
+      })
+
+      const backupNgJob = await xo.call('backupNg.getJob', { id: jobId })
+
+      expect(backupNgJob).toMatchSnapshot({
+        id: expect.any(String),
+        userId: expect.any(String),
+        settings: expect.any(Object),
+        vms: expect.any(Object),
+      })
+      expect(backupNgJob.vms).toEqual(defaultBackupNg.vms)
+      expect(backupNgJob.userId).toBe(xo._user.id)
+
+      expect(Object.keys(backupNgJob.settings).length).toBe(2)
+      const schedule = await xo.getSchedule({ jobId })
+      expect(typeof schedule).toBe('object')
+      expect(backupNgJob.settings[schedule.id]).toEqual({
+        snapshotRetention: 1,
+      })
+
+      expect(schedule).toMatchSnapshot({
+        id: expect.any(String),
+        jobId: expect.any(String),
+      })
+    })
+  })
+
+  describe('.delete() :', () => {
+    it('deletes a backup job', async () => {
+      const scheduleTempId = randomId()
+      const { id: jobId } = await xo.call('backupNg.createJob', {
+        ...defaultBackupNg,
+        schedules: {
+          [scheduleTempId]: DEFAULT_SCHEDULE,
+        },
+        settings: {
+          ...defaultBackupNg.settings,
+          [scheduleTempId]: { snapshotRetention: 1 },
+        },
+      })
+
+      const schedule = await xo.getSchedule({ jobId })
+      expect(typeof schedule).toBe('object')
+
+      await xo.call('backupNg.deleteJob', { id: jobId })
+
+      let isRejectedJobErrorValid = false
+      await xo.call('backupNg.getJob', { id: jobId }).catch(error => {
+        isRejectedJobErrorValid = noSuchObject.is(error)
+      })
+      expect(isRejectedJobErrorValid).toBe(true)
+
+      let isRejectedScheduleErrorValid = false
+      await xo.call('schedule.get', { id: schedule.id }).catch(error => {
+        isRejectedScheduleErrorValid = noSuchObject.is(error)
+      })
+      expect(isRejectedScheduleErrorValid).toBe(true)
+    })
+  })
+
+  describe('.runJob() :', () => {
+    it('fails trying to run a backup job without schedule', async () => {
+      const { id } = await xo.createTempBackupNgJob(defaultBackupNg)
+      await expect(xo.call('backupNg.runJob', { id })).rejects.toMatchSnapshot()
+    })
+
+    it('fails trying to run a backup job with no matching VMs', async () => {
+      const scheduleTempId = randomId()
+      const { id: jobId } = await xo.createTempBackupNgJob({
+        ...defaultBackupNg,
+        schedules: {
+          [scheduleTempId]: DEFAULT_SCHEDULE,
+        },
+        settings: {
+          [scheduleTempId]: { snapshotRetention: 1 },
+        },
+        vms: {
+          id: config.vms.default,
+          name: 'test-vm-backupNg',
+        },
+      })
+
+      const schedule = await xo.getSchedule({ jobId })
+      expect(typeof schedule).toBe('object')
+
+      await expect(
+        xo.call('backupNg.runJob', { id: jobId, schedule: schedule.id })
+      ).rejects.toMatchSnapshot()
+    })
+
+    it('fails trying to run a backup job with non-existent vm', async () => {
+      jest.setTimeout(7e3)
+      const scheduleTempId = randomId()
+      const { id: jobId } = await xo.createTempBackupNgJob({
+        ...defaultBackupNg,
+        schedules: {
+          [scheduleTempId]: DEFAULT_SCHEDULE,
+        },
+        settings: {
+          [scheduleTempId]: { snapshotRetention: 1 },
+        },
+        vms: {
+          id: 'non-existent-id',
+        },
+      })
+
+      const schedule = await xo.getSchedule({ jobId })
+      expect(typeof schedule).toBe('object')
+
+      await xo.call('backupNg.runJob', { id: jobId, schedule: schedule.id })
+      const [log] = await xo.call('backupNg.getLogs', {
+        scheduleId: schedule.id,
+      })
+      expect(log.warnings).toMatchSnapshot()
+    })
+
+    it('fails trying to run a backup job with a VM without disks', async () => {
+      jest.setTimeout(8e3)
+      await xo.createTempServer(config.servers.default)
+      const { id: vmIdWithoutDisks } = await xo.createTempVm({
+        name_label: 'XO Test Without Disks',
+        name_description: 'Creating a vm without disks',
+        template: config.templates.templateWithoutDisks,
+      })
+
+      const scheduleTempId = randomId()
+      const { id: jobId } = await xo.createTempBackupNgJob({
+        ...defaultBackupNg,
+        schedules: {
+          [scheduleTempId]: DEFAULT_SCHEDULE,
+        },
+        settings: {
+          ...defaultBackupNg.settings,
+          [scheduleTempId]: { snapshotRetention: 1 },
+        },
+        vms: {
+          id: vmIdWithoutDisks,
+        },
+      })
+
+      const schedule = await xo.getSchedule({ jobId })
+      expect(typeof schedule).toBe('object')
+      await xo.call('backupNg.runJob', { id: jobId, schedule: schedule.id })
+
+      const [
+        {
+          tasks: [vmTask],
+          ...log
+        },
+      ] = await xo.call('backupNg.getLogs', {
+        jobId,
+        scheduleId: schedule.id,
+      })
+      expect(log).toMatchSnapshot({
+        end: expect.any(Number),
+        id: expect.any(String),
+        jobId: expect.any(String),
+        scheduleId: expect.any(String),
+        start: expect.any(Number),
+      })
+
+      expect(vmTask).toMatchSnapshot({
+        end: expect.any(Number),
+        data: {
+          id: expect.any(String),
+        },
+        id: expect.any(String),
+        message: expect.any(String),
+        result: {
+          stack: expect.any(String),
+        },
+        start: expect.any(Number),
+      })
+
+      expect(vmTask.data.id).toBe(vmIdWithoutDisks)
+    })
+
+    it('fails trying to run backup job without retentions', async () => {
+      jest.setTimeout(7e3)
+      const scheduleTempId = randomId()
+      await xo.createTempServer(config.servers.default)
+      const { id: remoteId } = await xo.createTempRemote(config.remotes.default)
+      const { id: jobId } = await xo.createTempBackupNgJob({
+        ...defaultBackupNg,
+        remotes: {
+          id: remoteId,
+        },
+        schedules: {
+          [scheduleTempId]: DEFAULT_SCHEDULE,
+        },
+        settings: {
+          ...defaultBackupNg.settings,
+          [scheduleTempId]: {},
+        },
+        srs: {
+          id: config.srs.default,
+        },
+      })
+
+      const schedule = await xo.getSchedule({ jobId })
+      expect(typeof schedule).toBe('object')
+      await xo.call('backupNg.runJob', { id: jobId, schedule: schedule.id })
+
+      const [
+        {
+          tasks: [task],
+          ...log
+        },
+      ] = await xo.call('backupNg.getLogs', {
+        jobId,
+        scheduleId: schedule.id,
+      })
+
+      expect(log).toMatchSnapshot({
+        end: expect.any(Number),
+        id: expect.any(String),
+        jobId: expect.any(String),
+        scheduleId: expect.any(String),
+        start: expect.any(Number),
+      })
+
+      expect(task).toMatchSnapshot({
+        data: {
+          id: expect.any(String),
+        },
+        end: expect.any(Number),
+        id: expect.any(String),
+        message: expect.any(String),
+        result: {
+          stack: expect.any(String),
+        },
+        start: expect.any(Number),
+      })
+      expect(task.data.id).toBe(config.vms.default)
+    })
+  })
+
+  test('execute three times a rolling snapshot with 2 as retention & revert to an old state', async () => {
+    jest.setTimeout(6e4)
+    await xo.createTempServer(config.servers.default)
+    let vm = await xo.createTempVm({
+      name_label: 'XO Test Temp',
+      name_description: 'Creating a temporary vm',
+      template: config.templates.default,
+      VDIs: [
+        {
+          size: 1,
+          SR: config.srs.default,
+          type: 'user',
+        },
+      ],
+    })
+
+    const scheduleTempId = randomId()
+    const { id: jobId } = await xo.createTempBackupNgJob({
+      ...defaultBackupNg,
+      vms: {
+        id: vm.id,
+      },
+      schedules: {
+        [scheduleTempId]: DEFAULT_SCHEDULE,
+      },
+      settings: {
+        '': {
+          bypassVdiChainsCheck: true,
+          reportWhen: 'never',
+        },
+        [scheduleTempId]: { snapshotRetention: 2 },
+      },
+    })
+
+    const schedule = await xo.getSchedule({ jobId })
+    expect(typeof schedule).toBe('object')
+
+    for (let i = 0; i < 3; i++) {
+      await xo.call('backupNg.runJob', { id: jobId, schedule: schedule.id })
+      vm = await xo.waitObjectState(vm.id, ({ snapshots }) => {
+        // Test on updating snapshots.
+        expect(snapshots).not.toEqual(vm.snapshots)
+      })
+    }
+
+    // Test on the retention, how many snapshots should be saved.
+    expect(vm.snapshots.length).toBe(2)
+
+    const newVideoram = 16
+    await xo.call('vm.set', { id: vm.id, videoram: newVideoram })
+    await xo.waitObjectState(vm.id, ({ videoram }) => {
+      expect(videoram).toBe(newVideoram.toString())
+    })
+
+    await xo.call('vm.revert', {
+      snapshot: vm.snapshots[0],
+    })
+
+    await xo.waitObjectState(vm.id, ({ videoram }) => {
+      expect(videoram).toBe(vm.videoram)
+    })
+
+    const [
+      {
+        tasks: [{ tasks: subTasks, ...vmTask }],
+        ...log
+      },
+    ] = await xo.call('backupNg.getLogs', {
+      jobId,
+      scheduleId: schedule.id,
+    })
+
+    expect(log).toMatchSnapshot({
+      end: expect.any(Number),
+      id: expect.any(String),
+      jobId: expect.any(String),
+      scheduleId: expect.any(String),
+      start: expect.any(Number),
+    })
+
+    const subTaskSnapshot = subTasks.find(
+      ({ message }) => message === 'snapshot'
+    )
+    expect(subTaskSnapshot).toMatchSnapshot({
+      end: expect.any(Number),
+      id: expect.any(String),
+      result: expect.any(String),
+      start: expect.any(Number),
+    })
+
+    expect(vmTask).toMatchSnapshot({
+      data: {
+        id: expect.any(String),
+      },
+      end: expect.any(Number),
+      id: expect.any(String),
+      message: expect.any(String),
+      start: expect.any(Number),
+    })
+    expect(vmTask.data.id).toBe(vm.id)
+  })
+
+  test('execute three times a delta backup with 2 remotes, 2 as retention and 2 as fullInterval', async () => {
+    jest.setTimeout(12e5)
+    const {
+      vms: { default: defaultVm, vmToBackup = defaultVm },
+      remotes: { default: defaultRemote, remote1, remote2 = defaultRemote },
+      servers: { default: defaultServer },
+    } = config
+
+    expect(vmToBackup).not.toBe(undefined)
+    expect(remote1).not.toBe(undefined)
+    expect(remote2).not.toBe(undefined)
+
+    await xo.createTempServer(defaultServer)
+    const { id: remoteId1 } = await xo.createTempRemote(remote1)
+    const { id: remoteId2 } = await xo.createTempRemote(remote2)
+    const remotes = [remoteId1, remoteId2]
+
+    const exportRetention = 2
+    const fullInterval = 2
+    const scheduleTempId = randomId()
+    const { id: jobId } = await xo.createTempBackupNgJob({
+      mode: 'delta',
+      remotes: {
+        id: {
+          __or: remotes,
+        },
+      },
+      schedules: {
+        [scheduleTempId]: DEFAULT_SCHEDULE,
+      },
+      settings: {
+        '': {
+          bypassVdiChainsCheck: true,
+          fullInterval,
+          reportWhen: 'never',
+        },
+        [remoteId1]: { deleteFirst: true },
+        [scheduleTempId]: { exportRetention },
+      },
+      vms: {
+        id: vmToBackup,
+      },
+    })
+
+    const schedule = await xo.getSchedule({ jobId })
+    expect(typeof schedule).toBe('object')
+
+    const nExecutions = 3
+    const backupsByRemote = await xo.runBackupJob(jobId, schedule.id, {
+      remotes,
+      nExecutions,
+    })
+    forOwn(backupsByRemote, backups =>
+      expect(backups.length).toBe(exportRetention)
+    )
+
+    const backupLogs = await xo.call('backupNg.getLogs', {
+      jobId,
+      scheduleId: schedule.id,
+    })
+    expect(backupLogs.length).toBe(nExecutions)
+
+    backupLogs.forEach(({ tasks = [], ...log }, key) => {
+      validateRootTask(log, {
+        data: {
+          mode: 'delta',
+          reportWhen: 'never',
+        },
+        message: 'backup',
+        status: 'success',
+      })
+
+      const numberOfTasks = {
+        export: 0,
+        merge: 0,
+        snapshot: 0,
+        transfer: 0,
+        vm: 0,
+      }
+      tasks.forEach(({ tasks = [], ...vmTask }) => {
+        if (vmTask.data !== undefined && vmTask.data.type === 'VM') {
+          validateVmTask(vmTask, vmToBackup, { status: 'success' })
+          numberOfTasks.vm++
+          tasks.forEach(({ tasks = [], ...subTask }) => {
+            if (subTask.message === 'snapshot') {
+              validateSnapshotTask(subTask, { status: 'success' })
+              numberOfTasks.snapshot++
+            }
+            if (subTask.message === 'export') {
+              validateExportTask(subTask, remotes, {
+                data: {
+                  id: expect.any(String),
+                  isFull: key % fullInterval === 0,
+                  type: 'remote',
+                },
+                status: 'success',
+              })
+              numberOfTasks.export++
+              let mergeTaskKey, transferTaskKey
+              tasks.forEach((operationTask, key) => {
+                if (
+                  operationTask.message === 'transfer' ||
+                  operationTask.message === 'merge'
+                ) {
+                  validateOperationTask(operationTask, {
+                    result: { size: expect.any(Number) },
+                    status: 'success',
+                  })
+                  if (operationTask.message === 'transfer') {
+                    mergeTaskKey = key
+                    numberOfTasks.merge++
+                  } else {
+                    transferTaskKey = key
+                    numberOfTasks.transfer++
+                  }
+                }
+              })
+              expect(
+                subTask.data.id === remoteId1
+                  ? mergeTaskKey > transferTaskKey
+                  : mergeTaskKey < transferTaskKey
+              ).toBe(true)
+            }
+          })
+        }
+      })
+      expect(numberOfTasks).toEqual({
+        export: 2,
+        merge: 2,
+        snapshot: 1,
+        transfer: 2,
+        vm: 1,
+      })
+    })
+  })
+})

packages/xo-server-test/src/issues/index.spec.js

@@ -0,0 +1,51 @@
+/* eslint-env jest */
+
+import config from '../_config'
+import xo from '../_xoConnection'
+
+describe('issue', () => {
+  test('4507', async () => {
+    await xo.createTempServer(config.servers.default)
+
+    const props = {
+      coresPerSocket: 1,
+      cpuCap: 1,
+    }
+    const vm = await xo.createTempVm(props)
+    expect(vm).toMatchObject(props)
+
+    await xo.call('vm.set', {
+      coresPerSocket: null,
+      cpuCap: null,
+      id: vm.id,
+    })
+    await xo.waitObjectState(vm.id, vm => {
+      expect(vm.coresPerSocket).toBe(undefined)
+      expect(vm.cpuCap).toBe(undefined)
+    })
+  })
+
+  test('4514', async () => {
+    await xo.createTempServer(config.servers.default)
+
+    const oldName = 'Old XO Test name'
+    const { id, name_label } = await xo.createTempNetwork({ name: oldName })
+    expect(name_label).toBe(oldName)
+
+    const newName = 'New XO Test name'
+    await xo.call('network.set', { id, name_label: newName })
+    await xo.waitObjectState(id, ({ name_label }) => {
+      expect(name_label).toBe(newName)
+    })
+  })
+
+  test('4523', async () => {
+    const id = await xo.call('network.create', {
+      name: 'XO Test',
+      pool: config.pools.default,
+    })
+    expect(typeof id).toBe('string')
+
+    await xo.call('network.delete', { id })
+  })
+})

packages/xo-server-test/src/job/__snapshots__/job.spec.js.snap

@@ -0,0 +1,76 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`job .create() : creates a new job 1`] = `
+Object {
+  "id": Any<String>,
+  "key": "snapshot",
+  "method": "vm.snapshot",
+  "name": "jobTest",
+  "paramsVector": Any<Object>,
+  "timeout": 2000,
+  "type": "call",
+  "userId": Any<String>,
+}
+`;
+
+exports[`job .create() : fails trying to create a job without job params 1`] = `[JsonRpcError: invalid parameters]`;
+
+exports[`job .delete() : deletes an existing job 1`] = `[JsonRpcError: no such job [object Object]]`;
+
+exports[`job .delete() : deletes an existing job 2`] = `[JsonRpcError: no such schedule [object Object]]`;
+
+exports[`job .get() : fails trying to get a job with a non existent id 1`] = `[JsonRpcError: no such job [object Object]]`;
+
+exports[`job .get() : gets an existing job 1`] = `
+Object {
+  "id": Any<String>,
+  "key": "snapshot",
+  "method": "vm.snapshot",
+  "name": "jobTest",
+  "paramsVector": Any<Object>,
+  "timeout": 2000,
+  "type": "call",
+  "userId": Any<String>,
+}
+`;
+
+exports[`job .getAll() : gets all available jobs 1`] = `
+Object {
+  "id": Any<String>,
+  "key": "snapshot",
+  "method": "vm.snapshot",
+  "name": "jobTest",
+  "paramsVector": Any<Object>,
+  "timeout": 2000,
+  "type": "call",
+  "userId": Any<String>,
+}
+`;
+
+exports[`job .getAll() : gets all available jobs 2`] = `
+Object {
+  "id": Any<String>,
+  "key": "snapshot",
+  "method": "vm.snapshot",
+  "name": "jobTest2",
+  "paramsVector": Any<Object>,
+  "timeout": 2000,
+  "type": "call",
+  "userId": Any<String>,
+}
+`;
+
+exports[`job .set() : fails trying to set a job without job.id 1`] = `[JsonRpcError: invalid parameters]`;
+
+exports[`job .set() : sets a job 1`] = `
+Object {
+  "id": Any<String>,
+  "key": "snapshot",
+  "method": "vm.clone",
+  "name": "jobTest",
+  "paramsVector": Any<Object>,
+  "timeout": 2000,
+  "type": "call",
+  "userId": Any<String>,
+}
+`;

packages/xo-server-test/src/job/job.spec.js

@@ -0,0 +1,226 @@
+/* eslint-env jest */
+
+import { difference, keyBy } from 'lodash'
+
+import config from '../_config'
+import xo, { testWithOtherConnection } from '../_xoConnection'
+
+const ADMIN_USER = {
+  email: 'admin2@admin.net',
+  password: 'admin',
+  permission: 'admin',
+}
+
+describe('job', () => {
+  let defaultJob
+
+  beforeAll(() => {
+    defaultJob = {
+      name: 'jobTest',
+      timeout: 2000,
+      type: 'call',
+      key: 'snapshot',
+      method: 'vm.snapshot',
+      paramsVector: {
+        type: 'crossProduct',
+        items: [
+          {
+            type: 'set',
+            values: [
+              {
+                id: config.vms.default,
+                name: 'test-snapshot',
+              },
+            ],
+          },
+        ],
+      },
+    }
+  })
+
+  describe('.create() :', () => {
+    it('creates a new job', async () => {
+      jest.setTimeout(6e3)
+      const userId = await xo.createTempUser(ADMIN_USER)
+      const { email, password } = ADMIN_USER
+      await testWithOtherConnection({ email, password }, async xo => {
+        const id = await xo.call('job.create', { job: defaultJob })
+        expect(typeof id).toBe('string')
+
+        const job = await xo.call('job.get', { id })
+        expect(job).toMatchSnapshot({
+          id: expect.any(String),
+          paramsVector: expect.any(Object),
+          userId: expect.any(String),
+        })
+        expect(job.paramsVector).toEqual(defaultJob.paramsVector)
+        expect(job.userId).toBe(userId)
+        await xo.call('job.delete', { id })
+      })
+    })
+
+    it('creates a job with a userId', async () => {
+      const userId = await xo.createTempUser(ADMIN_USER)
+      const id = await xo.createTempJob({ ...defaultJob, userId })
+      const { userId: expectedUserId } = await xo.call('job.get', { id })
+      expect(userId).toBe(expectedUserId)
+    })
+
+    it('fails trying to create a job without job params', async () => {
+      await expect(xo.createTempJob({})).rejects.toMatchSnapshot()
+    })
+  })
+
+  describe('.getAll() :', () => {
+    it('gets all available jobs', async () => {
+      const jobId1 = await xo.createTempJob(defaultJob)
+      const job2 = {
+        ...defaultJob,
+        name: 'jobTest2',
+        paramsVector: {
+          type: 'crossProduct',
+          items: [
+            {
+              type: 'set',
+              values: [
+                {
+                  id: config.vms.default,
+                  name: 'test2-snapshot',
+                },
+              ],
+            },
+          ],
+        },
+      }
+      const jobId2 = await xo.createTempJob(job2)
+      let jobs = await xo.call('job.getAll')
+      expect(Array.isArray(jobs)).toBe(true)
+      jobs = keyBy(jobs, 'id')
+
+      const newJob1 = jobs[jobId1]
+      expect(newJob1).toMatchSnapshot({
+        id: expect.any(String),
+        paramsVector: expect.any(Object),
+        userId: expect.any(String),
+      })
+      expect(newJob1.paramsVector).toEqual(defaultJob.paramsVector)
+
+      const newJob2 = jobs[jobId2]
+      expect(newJob2).toMatchSnapshot({
+        id: expect.any(String),
+        paramsVector: expect.any(Object),
+        userId: expect.any(String),
+      })
+      expect(newJob2.paramsVector).toEqual(job2.paramsVector)
+    })
+  })
+
+  describe('.get() :', () => {
+    it('gets an existing job', async () => {
+      const id = await xo.createTempJob(defaultJob)
+      const job = await xo.call('job.get', { id })
+      expect(job).toMatchSnapshot({
+        id: expect.any(String),
+        paramsVector: expect.any(Object),
+        userId: expect.any(String),
+      })
+      expect(job.paramsVector).toEqual(defaultJob.paramsVector)
+    })
+
+    it('fails trying to get a job with a non existent id', async () => {
+      await expect(
+        xo.call('job.get', { id: 'non-existent-id' })
+      ).rejects.toMatchSnapshot()
+    })
+  })
+
+  describe('.set() :', () => {
+    it('sets a job', async () => {
+      const id = await xo.createTempJob(defaultJob)
+      const job = {
+        id,
+        type: 'call',
+        key: 'snapshot',
+        method: 'vm.clone',
+        paramsVector: {
+          type: 'crossProduct',
+          items: [
+            {
+              type: 'set',
+              values: [
+                {
+                  id: config.vms.default,
+                  name: 'clone',
+                  full_copy: true,
+                },
+              ],
+            },
+          ],
+        },
+      }
+
+      await xo.call('job.set', {
+        job,
+      })
+
+      const newJob = await xo.call('job.get', { id })
+      expect(newJob).toMatchSnapshot({
+        id: expect.any(String),
+        paramsVector: expect.any(Object),
+        userId: expect.any(String),
+      })
+      expect(newJob.paramsVector).toEqual(job.paramsVector)
+    })
+
+    it('fails trying to set a job without job.id', async () => {
+      await expect(xo.call('job.set', defaultJob)).rejects.toMatchSnapshot()
+    })
+  })
+
+  describe('.delete() :', () => {
+    it('deletes an existing job', async () => {
+      const id = await xo.call('job.create', { job: defaultJob })
+      const { id: scheduleId } = await xo.call('schedule.create', {
+        jobId: id,
+        cron: '* * * * * *',
+        enabled: false,
+      })
+      await xo.call('job.delete', { id })
+      await expect(xo.call('job.get', { id })).rejects.toMatchSnapshot()
+      await expect(
+        xo.call('schedule.get', { id: scheduleId })
+      ).rejects.toMatchSnapshot()
+    })
+
+    it.skip('fails trying to delete a job with a non existent id', async () => {
+      await expect(
+        xo.call('job.delete', { id: 'non-existent-id' })
+      ).rejects.toMatchSnapshot()
+    })
+  })
+
+  describe('.runSequence() :', () => {
+    let id
+
+    afterEach(async () => {
+      await xo
+        .call('vm.delete', { id, deleteDisks: true })
+        .catch(error => console.error(error))
+    })
+
+    it('runs a job', async () => {
+      jest.setTimeout(7e4)
+      await xo.createTempServer(config.servers.default)
+      const jobId = await xo.createTempJob(defaultJob)
+      const snapshots = xo.objects.all[config.vms.default].snapshots
+      await xo.call('job.runSequence', { idSequence: [jobId] })
+      await xo.waitObjectState(
+        config.vms.default,
+        ({ snapshots: actualSnapshots }) => {
+          expect(actualSnapshots.length).toBe(snapshots.length + 1)
+          id = difference(actualSnapshots, snapshots)[0]
+        }
+      )
+    })
+  })
+})

packages/xo-server-test/src/old-tests/disk.spec.js

@@ -0,0 +1,156 @@
+/* eslint-env jest */
+
+// Doc: https://github.com/moll/js-must/blob/master/doc/API.md#must
+import expect from 'must'
+
+// ===================================================================
+
+import { getConfig, getMainConnection, getSrId, waitObjectState } from './util'
+import { map, assign } from 'lodash'
+import eventToPromise from 'event-to-promise'
+
+// ===================================================================
+
+describe('disk', () => {
+  let diskId
+  let diskIds = []
+  let serverId
+  let srId
+  let xo
+
+  // -----------------------------------------------------------------
+
+  beforeAll(async () => {
+    jest.setTimeout(10e3)
+    xo = await getMainConnection()
+
+    const config = await getConfig()
+    serverId = await xo.call(
+      'server.add',
+      assign({ autoConnect: false }, config.xenServer1)
+    )
+    await xo.call('server.connect', { id: serverId })
+    await eventToPromise(xo.objects, 'finish')
+    srId = await getSrId(xo)
+  })
+
+  // -----------------------------------------------------------------
+
+  afterEach(async () => {
+    await Promise.all(
+      map(diskIds, diskId => xo.call('vdi.delete', { id: diskId }))
+    )
+    diskIds = []
+  })
+
+  // -----------------------------------------------------------------
+
+  afterAll(async () => {
+    await xo.call('server.remove', { id: serverId })
+  })
+
+  // -----------------------------------------------------------------
+
+  async function createDisk(params) {
+    const id = await xo.call('disk.create', params)
+    diskIds.push(id)
+    return id
+  }
+
+  async function createDiskTest() {
+    const id = await createDisk({
+      name: 'diskTest',
+      size: '1GB',
+      sr: srId,
+    })
+    return id
+  }
+
+  // ===================================================================
+
+  describe('.create()', () => {
+    it('create a new disk on a SR', async () => {
+      diskId = await createDisk({
+        name: 'diskTest',
+        size: '1GB',
+        sr: srId,
+      })
+
+      await Promise.all([
+        waitObjectState(xo, diskId, disk => {
+          expect(disk.type).to.be.equal('VDI')
+          expect(disk.name_label).to.be.equal('diskTest')
+          // TODO: should not test an exact value but around 10%
+          expect(disk.size).to.be.equal(1000341504)
+          expect(disk.$SR).to.be.equal(srId)
+        }),
+        waitObjectState(xo, srId, sr => {
+          expect(sr.VDIs).include(diskId)
+        }),
+      ])
+    })
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.delete()', () => {
+    beforeEach(async () => {
+      diskId = await createDiskTest()
+    })
+
+    it('deletes a disk', async () => {
+      await Promise.all([
+        xo.call('vdi.delete', { id: diskId }),
+        waitObjectState(xo, diskId, disk => {
+          expect(disk).to.be.undefined()
+        }),
+        waitObjectState(xo, srId, sr => {
+          expect(sr.VDIs).not.include(diskId)
+        }),
+      ])
+      diskIds = []
+    })
+  })
+
+  // ---------------------------------------------------------------------
+
+  describe('.set()', () => {
+    beforeEach(async () => {
+      diskId = await createDiskTest()
+    })
+
+    it('set the name of the disk', async () => {
+      await xo.call('vdi.set', {
+        id: diskId,
+        name_label: 'disk2',
+      })
+
+      await waitObjectState(xo, diskId, disk => {
+        expect(disk.name_label).to.be.equal('disk2')
+      })
+    })
+
+    it('set the description of the disk', async () => {
+      await xo.call('vdi.set', {
+        id: diskId,
+        name_description: 'description',
+      })
+
+      await waitObjectState(xo, diskId, disk => {
+        expect(disk.name_description).to.be.equal('description')
+      })
+    })
+
+    it.skip('set the size of the disk', async () => {
+      await xo.getOrWaitObject(diskId)
+      await xo.call('vdi.set', {
+        id: diskId,
+        size: '5MB',
+      })
+
+      await waitObjectState(xo, diskId, disk => {
+        expect(disk.size).to.be.equal(6291456)
+      })
+    })
+  })
+})

packages/xo-server-test/src/old-tests/docker.spec.js

@@ -0,0 +1,59 @@
+/* eslint-env jest */
+
+// Doc: https://github.com/moll/js-must/blob/master/doc/API.md#must
+// import expect from 'must'
+
+// ===================================================================
+
+// import {getConnection} from './util'
+
+// ===================================================================
+
+describe('docker', () => {
+  // let xo
+  // beforeAll(async () => {
+  //   xo = await getConnection()
+  // })
+
+  // ===================================================================
+
+  describe('.register()', async () => {
+    it('registers the VM for Docker management')
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.deregister()', async () => {
+    it('deregister the VM for Docker management')
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.start()', async () => {
+    it('starts the Docker')
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.stop()', async () => {
+    it('stops the Docker')
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.restart()', async () => {
+    it('restarts the Docker')
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.pause()', async () => {
+    it('pauses the Docker')
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.unpause()', async () => {
+    it('unpauses the Docker')
+  })
+})

packages/xo-server-test/src/old-tests/group.spec.js

@@ -0,0 +1,377 @@
+/* eslint-env jest */
+
+import { find, map } from 'lodash'
+
+import { createUser, deleteUsers, getUser, xo } from './util.js'
+
+// ===================================================================
+describe('group', () => {
+  const userIds = []
+  const groupIds = []
+
+  // -----------------------------------------------------------------
+
+  afterEach(async () => {
+    await Promise.all(map(groupIds, id => xo.call('group.delete', { id })))
+    // Deleting users must be done AFTER deleting the group
+    // because there is a race condition in xo-server
+    // which cause some users to not be properly deleted.
+
+    // The test “delete the group with its users” highlight this issue.
+    await deleteUsers(xo, userIds)
+    userIds.length = groupIds.length = 0
+  })
+
+  // -----------------------------------------------------------------
+
+  async function createGroup(params) {
+    const groupId = await xo.call('group.create', params)
+    groupIds.push(groupId)
+    return groupId
+  }
+
+  // ----------------------------------------------------------------
+
+  function compareGroup(actual, expected) {
+    expect(actual.name).toEqual(expected.name)
+    expect(actual.id).toEqual(expected.id)
+    expect(actual.users).toEqual(expected.users)
+  }
+
+  // ----------------------------------------------------------------
+
+  function getAllGroups() {
+    return xo.call('group.getAll')
+  }
+
+  // ---------------------------------------------------------------
+
+  async function getGroup(id) {
+    const groups = await getAllGroups()
+    return find(groups, { id: id })
+  }
+
+  // =================================================================
+
+  describe('.create()', () => {
+    it('creates a group and return its id', async () => {
+      const groupId = await createGroup({
+        name: 'Avengers',
+      })
+      const group = await getGroup(groupId)
+      compareGroup(group, {
+        id: groupId,
+        name: 'Avengers',
+        users: [],
+      })
+    })
+
+    it.skip('does not create two groups with the same name', async () => {
+      await createGroup({
+        name: 'Avengers',
+      })
+
+      await createGroup({
+        name: 'Avengers',
+      }).then(
+        () => {
+          throw new Error('createGroup() should have thrown')
+        },
+        function(error) {
+          expect(error.message).to.match(/duplicate group/i)
+        }
+      )
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.delete()', () => {
+    let groupId
+    let userId1
+    let userId2
+    let userId3
+    beforeEach(async () => {
+      groupId = await xo.call('group.create', {
+        name: 'Avengers',
+      })
+    })
+    it('delete a group', async () => {
+      await xo.call('group.delete', {
+        id: groupId,
+      })
+      const group = await getGroup(groupId)
+      expect(group).toBeUndefined()
+    })
+
+    it.skip("erase the group from user's groups list", async () => {
+      // create user and add it to the group
+      const userId = await createUser(xo, userIds, {
+        email: 'tony.stark@stark_industry.com',
+        password: 'IronMan',
+      })
+      await xo.call('group.addUser', {
+        id: groupId,
+        userId: userId,
+      })
+
+      // delete the group
+      await xo.call('group.delete', { id: groupId })
+      const user = await getUser(userId)
+      expect(user.groups).toEqual([])
+    })
+
+    it.skip("erase the user from group's users list", async () => {
+      // create user and add it to the group
+      const userId = await createUser(xo, userIds, {
+        email: 'tony.stark@stark_industry.com',
+        password: 'IronMan',
+      })
+      await xo.call('group.addUser', {
+        id: groupId,
+        userId: userId,
+      })
+
+      // delete the group
+      await xo.call('user.delete', { id: userId })
+      const group = await getGroup(groupId)
+      expect(group.users).toEqual([])
+    })
+
+    // FIXME: some users are not properly deleted because of a race condition with group deletion.
+    it.skip('delete the group with its users', async () => {
+      // create users
+      ;[userId1, userId2, userId3] = await Promise.all([
+        xo.call('user.create', {
+          email: 'tony.stark@stark_industry.com',
+          password: 'IronMan',
+        }),
+        xo.call('user.create', {
+          email: 'natasha.romanov@shield.com',
+          password: 'BlackWidow',
+        }),
+        xo.call('user.create', {
+          email: 'pietro.maximoff@shield.com',
+          password: 'QickSilver',
+        }),
+      ])
+
+      await xo.call('group.setUsers', {
+        id: groupId,
+        userIds: [userId1, userId2, userId3],
+      })
+
+      // delete the group with his users
+      await Promise.all([
+        xo.call('group.delete', {
+          id: groupId,
+        }),
+        deleteUsers(xo, [userId1, userId2, userId3]),
+      ])
+
+      const [group, user1, user2, user3] = await Promise.all([
+        getGroup(groupId),
+        getUser(xo, userId1),
+        getUser(xo, userId2),
+        getUser(xo, userId3),
+      ])
+
+      expect(group).toBeUndefined()
+      expect(user1).toBeUndefined()
+      expect(user2).toBeUndefined()
+      expect(user3).toBeUndefined()
+    })
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.getAll()', () => {
+    it('returns an array', async () => {
+      const groups = await xo.call('group.getAll')
+      expect(groups).toBeInstanceOf(Array)
+    })
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.setUsers ()', () => {
+    let groupId
+    let userId1
+    let userId2
+    let userId3
+    beforeEach(async () => {
+      ;[groupId, userId1, userId2, userId3] = await Promise.all([
+        createGroup({
+          name: 'Avengers',
+        }),
+        createUser(xo, userIds, {
+          email: 'tony.stark@stark_industry.com',
+          password: 'IronMan',
+        }),
+        createUser(xo, userIds, {
+          email: 'natasha.romanov@shield.com',
+          password: 'BlackWidow',
+        }),
+        createUser(xo, userIds, {
+          email: 'pietro.maximoff@shield.com',
+          password: 'QickSilver',
+        }),
+      ])
+    })
+
+    it('can set users of a group', async () => {
+      // add two users on the group
+      await xo.call('group.setUsers', {
+        id: groupId,
+        userIds: [userId1, userId2],
+      })
+      {
+        const [group, user1, user2, user3] = await Promise.all([
+          getGroup(groupId),
+          getUser(xo, userId1),
+          getUser(xo, userId2),
+          getUser(xo, userId3),
+        ])
+        compareGroup(group, {
+          id: groupId,
+          name: 'Avengers',
+          users: [userId1, userId2],
+        })
+
+        expect(user1.groups).toEqual([groupId])
+        expect(user2.groups).toEqual([groupId])
+        expect(user3.groups).toEqual([])
+      }
+
+      // change users of the group
+      await xo.call('group.setUsers', {
+        id: groupId,
+        userIds: [userId1, userId3],
+      })
+      {
+        const [group, user1, user2, user3] = await Promise.all([
+          getGroup(groupId),
+          getUser(xo, userId1),
+          getUser(xo, userId2),
+          getUser(xo, userId3),
+        ])
+
+        compareGroup(group, {
+          id: groupId,
+          name: 'Avengers',
+          users: [userId1, userId3],
+        })
+
+        expect(user1.groups).toEqual([groupId])
+        expect(user2.groups).toEqual([])
+        expect(user3.groups).toEqual([groupId])
+      }
+    })
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('.addUser()', () => {
+    let groupId
+    let userId
+    beforeEach(async () => {
+      ;[groupId, userId] = await Promise.all([
+        createGroup({
+          name: 'Avengers',
+        }),
+        createUser(xo, userIds, {
+          email: 'tony.stark@stark_industry.com',
+          password: 'IronMan',
+        }),
+      ])
+    })
+
+    it('adds a user id to a group', async () => {
+      await xo.call('group.addUser', {
+        id: groupId,
+        userId: userId,
+      })
+
+      const [group, user] = await Promise.all([
+        getGroup(groupId),
+        getUser(xo, userId),
+      ])
+
+      compareGroup(group, {
+        id: groupId,
+        name: 'Avengers',
+        users: [userId],
+      })
+
+      expect(user.groups).toEqual([groupId])
+    })
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('removeUser()', () => {
+    let groupId
+    let userId
+    beforeEach(async () => {
+      ;[groupId, userId] = await Promise.all([
+        createGroup({
+          name: 'Avengers',
+        }),
+        createUser(xo, userIds, {
+          email: 'tony.stark@stark_industry.com',
+          password: 'IronMan',
+        }),
+      ])
+
+      await xo.call('group.addUser', {
+        id: groupId,
+        userId: userId,
+      })
+    })
+
+    it('removes a user to a group', async () => {
+      await xo.call('group.removeUser', {
+        id: groupId,
+        userId: userId,
+      })
+
+      const [group, user] = await Promise.all([
+        getGroup(groupId),
+        getUser(xo, userId),
+      ])
+
+      compareGroup(group, {
+        id: groupId,
+        name: 'Avengers',
+        users: [],
+      })
+
+      expect(user.groups).toEqual([])
+    })
+  })
+
+  // -------------------------------------------------------------------
+
+  describe('set()', () => {
+    let groupId
+    beforeEach(async () => {
+      groupId = await createGroup({
+        name: 'Avengers',
+      })
+    })
+
+    it('changes name of a group', async () => {
+      await xo.call('group.set', {
+        id: groupId,
+        name: 'Guardians of the Galaxy',
+      })
+
+      const group = await getGroup(groupId)
+      compareGroup(group, {
+        id: groupId,
+        name: 'Guardians of the Galaxy',
+        users: [],
+      })
+    })
+  })
+})

packages/xo-server-test/src/old-tests/host.spec.js

@@ -0,0 +1,239 @@
+/* eslint-env jest */
+
+// Doc: https://github.com/moll/js-must/blob/master/doc/API.md#must
+
+import expect from 'must'
+import eventToPromise from 'event-to-promise'
+import {
+  getAllHosts,
+  getConfig,
+  getMainConnection,
+  getVmToMigrateId,
+  waitObjectState,
+} from './util'
+import { find, forEach } from 'lodash'
+
+// ===================================================================
+
+describe('host', () => {
+  let xo
+  let serverId
+  let hostId
+
+  // -----------------------------------------------------------------
+
+  beforeAll(async () => {
+    jest.setTimeout(10e3)
+    let config
+    ;[xo, config] = await Promise.all([getMainConnection(), getConfig()])
+    serverId = await xo.call('server.add', config.xenServer2).catch(() => {})
+    await eventToPromise(xo.objects, 'finish')
+
+    hostId = getHost(config.host1)
+  })
+
+  // -------------------------------------------------------------------
+
+  afterAll(async () => {
+    await xo.call('server.remove', {
+      id: serverId,
+    })
+  })
+
+  // -------------------------------------------------------------------
+
+  function getHost(nameLabel) {
+    const hosts = getAllHosts(xo)
+    const host = find(hosts, { name_label: nameLabel })
+    return host.id
+  }
+
+  // ===================================================================
+
+  describe('.set()', () => {
+    let nameLabel
+    let nameDescription
+
+    beforeEach(async () => {
+      // get values to set them at the end of the test
+      const host = xo.objects.all[hostId]
+      nameLabel = host.name_label
+      nameDescription = host.name_description
+    })
+    afterEach(async () => {
+      await xo.call('host.set', {
+        id: hostId,
+        name_label: nameLabel,
+        name_description: nameDescription,
+      })
+    })
+
+    it('changes properties of the host', async () => {
+      await xo.call('host.set', {
+        id: hostId,
+        name_label: 'labTest',
+        name_description: 'description',
+      })
+      await waitObjectState(xo, hostId, host => {
+        expect(host.name_label).to.be.equal('labTest')
+        expect(host.name_description).to.be.equal('description')
+      })
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.restart()', () => {
+    jest.setTimeout(330e3)
+    it('restart the host', async () => {
+      await xo.call('host.restart', { id: hostId })
+
+      await waitObjectState(xo, hostId, host => {
+        expect(host.current_operations)
+      })
+      await waitObjectState(xo, hostId, host => {
+        expect(host.power_state).to.be.equal('Halted')
+      })
+      await waitObjectState(xo, hostId, host => {
+        expect(host.power_state).to.be.equal('Running')
+      })
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.restartAgent()', () => {
+    it('restart a Xen agent on the host')
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.start()', () => {
+    jest.setTimeout(300e3)
+    beforeEach(async () => {
+      try {
+        await xo.call('host.stop', { id: hostId })
+      } catch (_) {}
+
+      // test if the host is shutdown
+      await waitObjectState(xo, hostId, host => {
+        expect(host.power_state).to.be.equal('Halted')
+      })
+    })
+
+    it('start the host', async () => {
+      await xo.call('host.start', { id: hostId })
+      await waitObjectState(xo, hostId, host => {
+        expect(host.power_state).to.be.equal('Running')
+      })
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.stop()', () => {
+    jest.setTimeout(300e3)
+    let vmId
+
+    beforeAll(async () => {
+      vmId = await getVmToMigrateId(xo)
+      try {
+        await xo.call('vm.start', { id: vmId })
+      } catch (_) {}
+      try {
+        await xo.call('vm.migrate', {
+          vm: vmId,
+          host: hostId,
+        })
+      } catch (_) {}
+    })
+    afterEach(async () => {
+      await xo.call('host.start', { id: hostId })
+    })
+
+    it('stop the host and shutdown its VMs', async () => {
+      await xo.call('host.stop', { id: hostId })
+      await Promise.all([
+        waitObjectState(xo, vmId, vm => {
+          expect(vm.$container).not.to.be.equal(hostId)
+          expect(vm.power_state).to.be.equal('Halted')
+        }),
+        waitObjectState(xo, hostId, host => {
+          expect(host.power_state).to.be.equal('Halted')
+        }),
+      ])
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.detach()', () => {
+    it('ejects the host of a pool')
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.disable(), ', () => {
+    afterEach(async () => {
+      await xo.call('host.enable', {
+        id: hostId,
+      })
+    })
+
+    it('disables to create VM on the host', async () => {
+      await xo.call('host.disable', { id: hostId })
+      await waitObjectState(xo, hostId, host => {
+        expect(host.enabled).to.be.false()
+      })
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.enable()', async () => {
+    beforeEach(async () => {
+      await xo.call('host.disable', { id: hostId })
+    })
+
+    it('enables to create VM on the host', async () => {
+      await xo.call('host.enable', { id: hostId })
+
+      await waitObjectState(xo, hostId, host => {
+        expect(host.enabled).to.be.true()
+      })
+    })
+  })
+
+  // -----------------------------------------------------------------
+  describe('.createNetwork()', () => {
+    it('create a network')
+  })
+
+  // -----------------------------------------------------------------
+
+  describe('.listMissingPatches()', () => {
+    it('returns an array of missing patches in the host')
+    it('returns a empty array if up-to-date')
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.installPatch()', () => {
+    it('installs a patch patch on the host')
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.stats()', () => {
+    it('returns an array with statistics of the host', async () => {
+      const stats = await xo.call('host.stats', {
+        host: hostId,
+      })
+      expect(stats).to.be.an.object()
+
+      forEach(stats, function(array, key) {
+        expect(array).to.be.an.array()
+      })
+    })
+  })
+})

packages/xo-server-test/src/old-tests/pool.spec.js

@@ -0,0 +1,79 @@
+/* eslint-env jest */
+
+// Doc: https://github.com/moll/js-must/blob/master/doc/API.md#must
+import expect from 'must'
+
+// ===================================================================
+
+import { getConfig, getMainConnection, waitObjectState } from './util'
+import eventToPromise from 'event-to-promise'
+import { find } from 'lodash'
+
+// ===================================================================
+
+describe('pool', () => {
+  let xo
+  let serverId
+  let poolId
+  let config
+
+  beforeAll(async () => {
+    jest.setTimeout(10e3)
+    ;[xo, config] = await Promise.all([getMainConnection(), getConfig()])
+    serverId = await xo.call('server.add', config.xenServer1).catch(() => {})
+    await eventToPromise(xo.objects, 'finish')
+    poolId = getPoolId()
+  })
+
+  // -------------------------------------------------------------------
+
+  afterAll(async () => {
+    await xo.call('server.remove', {
+      id: serverId,
+    })
+  })
+
+  // -----------------------------------------------------------------
+
+  function getPoolId() {
+    const pools = xo.objects.indexes.type.pool
+    const pool = find(pools, { name_label: config.pool.name_label })
+    return pool.id
+  }
+
+  // ===================================================================
+
+  describe('.set()', () => {
+    afterEach(async () => {
+      await xo.call('pool.set', {
+        id: poolId,
+        name_label: config.pool.name_label,
+        name_description: '',
+      })
+    })
+    it.skip('set pool parameters', async () => {
+      await xo.call('pool.set', {
+        id: poolId,
+        name_label: 'nameTest',
+        name_description: 'description',
+      })
+
+      await waitObjectState(xo, poolId, pool => {
+        expect(pool.name_label).to.be.equal('nameTest')
+        expect(pool.name_description).to.be.equal('description')
+      })
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('.installPatch()', () => {
+    it('install a patch on the pool')
+  })
+
+  // -----------------------------------------------------------------
+
+  describe('handlePatchUpload()', () => {
+    it('')
+  })
+})

packages/xo-server-test/src/old-tests/role.spec.js

@@ -0,0 +1,33 @@
+/* eslint-env jest */
+
+import { xo } from './util'
+
+// ===================================================================
+
+describe('role', () => {
+  describe('.getAll()', () => {
+    it(' returns all the roles', async () => {
+      const role = await xo.call('role.getAll')
+
+      // FIXME: use permutationOf but figure out how not to compare objects by
+      // equality.
+      expect(role).toEqual([
+        {
+          id: 'viewer',
+          name: 'Viewer',
+          permissions: ['view'],
+        },
+        {
+          id: 'operator',
+          name: 'Operator',
+          permissions: ['view', 'operate'],
+        },
+        {
+          id: 'admin',
+          name: 'Admin',
+          permissions: ['view', 'operate', 'administrate'],
+        },
+      ])
+    })
+  })
+})