Initial version

Author: root

.env.example

@@ -0,0 +1,2 @@
+# Configures the pino log level: debug, info, warn, error
+LOG_LEVEL=info

.eslintrc.yml

@@ -0,0 +1,9 @@
+env:
+  browser: true
+  es2021: true
+extends:
+  - standard
+parserOptions:
+  ecmaVersion: 12
+  sourceType: module
+rules: {}

.gitignore

@@ -1,104 +1,6 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directories
 node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
 
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
+# Project files
 .env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
+config.yaml

README.md

@@ -1 +1,10 @@
-# btrfs-backups
+# btrfs-backups
+
+Tool for creating and managing backups using BTRFS snapshots and btrfs-sxbackup script.
+
+Requires external scripts to be available in `$PATH`:
+
+- https://github.com/masc3d/btrfs-sxbackup
+
+- https://github.com/MurzNN/btrfs-du/tree/patch-1 (original [btrfs-du](https://github.com/nachoparker/btrfs-du) with [PR #24](https://github.com/nachoparker/btrfs-du/pull/24))
+

backup.js

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+
+import * as fs from 'fs'
+import * as yaml from 'js-yaml'
+import { performance } from 'perf_hooks'
+import { serializeError } from 'serialize-error'
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+
+import { logger } from './lib/logger.js'
+import { timingsToSpans } from './lib/utils.js'
+import * as sxbackup from './lib/btrfs-sxbackup.js'
+import * as btrfs from './lib/btrfs.js'
+
+const configFile = 'config.yaml'
+
+/* Loading the config file */
+let config
+try {
+  const fileContents = fs.readFileSync(new URL(configFile, import.meta.url), 'utf8')
+  config = yaml.load(fileContents)
+} catch (e) {
+  console.log(e)
+  logger.error(serializeError(e), 'Probjems with loading config file \'config.yaml\'')
+  process.exit(1)
+}
+
+/**
+ * Does a single backup job.
+ *
+ * @param {string} job - job name, matching to config file key
+ */
+
+const backupDo = function (job) {
+  let op
+  const timings = {}
+  try {
+    timings.start = performance.now()
+    op = 'info'
+    const info = sxbackup.info(job)
+    timings[op] = performance.now()
+
+    op = 'run'
+    sxbackup.run(info['Source URL'])
+    timings[op] = performance.now()
+
+    op = 'check'
+    const checkStat = btrfs.check(info['Destination URL'])
+    timings[op] = performance.now()
+    const stat = {
+      ...checkStat,
+      timings: timingsToSpans(timings)
+    }
+    logger.info({
+      function: 'backupDo',
+      job,
+      ...stat
+    }, `Backup job ${job} finished`)
+  } catch (e) {
+    logger.error({
+      function: 'backupDo',
+      job: job,
+      stage: op,
+      exception: serializeError(e)
+    }, `Backup job ${job} failed on stage '${op}'`)
+  }
+}
+
+/**
+ * Configures a backup job (creates new or updates config).
+ *
+ * @param {string} job - job name, matching to config file key
+ */
+
+export const backupConfigure = function (job) {
+  const action = sxbackup.info(job) === false
+    ? 'init'
+    : 'update'
+  sxbackup.configure(
+    action,
+    job,
+    config.jobs[job].destination,
+    job.retention?.source ?? config.retentionDefault.source,
+    job.retention?.destination ?? config.retentionDefault.destination
+  )
+  logger.info({
+    function: 'backupConfigure',
+    source: job,
+    destination: config.jobs[job].destination,
+    sr: job.retention?.source ?? config.retentionDefault.source,
+    dr: job.retention?.destination ?? config.retentionDefault.destination
+  }, `Backup job ${job} configured`)
+}
+
+/**
+ * Launches the configure job for all configured backup jobs.
+ *
+ * @param {string} argv - cli arguments
+ */
+
+const doConfigure = function (argv = {}) {
+  logger.info('Update backup jobs started')
+  for (const job in config.jobs) {
+    backupConfigure(job)
+  }
+  logger.info('Update backup jobs finished')
+}
+
+/**
+ * Launches the backup job for all configured backup jobs.
+ *
+ * @param {string} argv - cli arguments
+ */
+
+const doBackups = function (argv = {}) {
+  logger.info('Backup process started')
+  for (const job in config.jobs) {
+    backupDo(job)
+  }
+  logger.info('Backup process finished')
+}
+
+// eslint-disable-next-line no-unused-expressions
+yargs(hideBin(process.argv))
+  .command('configure', 'Configure (create and update) backup jobs', () => {}, (argv) => {
+    doConfigure(argv)
+  })
+  .command('backup', 'Execute backup jobs', () => {}, (argv) => {
+    doBackups(argv)
+  })
+  .demandCommand(1)
+  .argv

config.example.yaml

@@ -0,0 +1,27 @@
+# Default retention rules using btrfs-sxbackup expression:
+# From https://github.com/masc3d/btrfs-sxbackup/blob/master/README.rst
+# > Expression defining which source snapshots to
+# > retain/cleanup. can be a static number (of backups) or
+# > more complex expression like "1d:4/d, 1w:daily,
+# > 2m:none" literally translating to: "1 day from now
+# > keep 4 backups a day, 1 week from now keep daily
+# > backups, 2 months from now keep none"
+retentionDefault:
+  source: "3"
+  destination: "1d:1/d, 1w:daily, 2w:daily, 3w:daily, 4w:daily 5w:none"
+
+# List of jobs to make backup process
+# key - source btrfs volume mount path
+# destination - destination btrfs volume mount path
+jobs:
+  '/var/lib/mysql':
+    destination: '/var/backups/mysql'
+
+  '/var/lib/postgresql':
+    destination: '/var/backups/postgresql'
+
+  '/srv':
+    destination: '/var/backups/srv'
+
+  '/home':
+    destination: '/var/backups/home'

lib/btrfs-sxbackup.js

@@ -0,0 +1,73 @@
+import { execSync } from 'child_process'
+
+/**
+ * Executes btrfs-sxbackup info action on given url.
+ *
+ * @param {string} url - backup identifier (source or destination)
+ */
+
+export const info = function (url) {
+  const output = execSync(`btrfs-sxbackup info ${url}`).toString()
+  if (output.search('ERROR') !== -1) {
+    // throw new Error(output)
+    return false
+  }
+  const outputParsed = output.matchAll(/^\s{3}(?<key>.+?)\s\s+(?<value>.+(?:\n {26}\w.+$)*)$/mg)
+  // console.log(output.toString())
+  // console.log(...outputParsed)
+  const result = {}
+  for (const item of outputParsed) {
+    result[item.groups.key] = item.groups.value.replace(/^ {26}/gm, '')
+  }
+  return result
+}
+
+/**
+ * Executes btrfs-sxbackup run action on given url.
+ *
+ * @param {string} url - backup identifier (source or destination)
+ */
+
+export const run = function (url) {
+  const output = execSync(`btrfs-sxbackup run ${url}`)
+
+  const outputParsed = output.toString().match(/(?<name>[^\s]+) created successfully/)
+
+  if (!outputParsed.groups.name) {
+    throw new Error('Missing success result')
+  }
+
+  return outputParsed.groups.name
+}
+
+/**
+ * Executes btrfs-sxbackup purge action on given url.
+ *
+ * @param {string} url - backup identifier (source or destination)
+ */
+
+export const purge = function (url) {
+  execSync(`btrfs-sxbackup purge ${url}`)
+}
+
+/**
+ * Configuring the backup job.
+ *
+ * @param {string} action - init | update
+ * @param {string} source - source location
+ * @param {string} destination - destination location
+ * @param {string} sr - source retention rules
+ * @param {string} dr - destination retention rules
+ */
+export const configure = function (action, source, destination, sr, dr) {
+  if (['init', 'update'].indexOf(action) === -1) {
+    throw new Error('action argument must be only "init" or "update"')
+  }
+  const cmd = `btrfs-sxbackup ${action} -sr "${sr}" -dr "${dr}" ${source} ${destination}`
+  // console.log(cmd)
+  try {
+    execSync(cmd)
+  } catch (e) {
+    throw new Error('Execution failed: ' + e.output.toString())
+  }
+}